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
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_dbg.h>
51 #include <scsi/scsi_eh.h>
52 #include <scsi/scsi_tcq.h>
54 #include <target/target_core_base.h>
55 #include <target/target_core_fabric.h>
56 #include <target/target_core_configfs.h>
57 #include <target/target_core_fabric_configfs.h>
59 #include <asm/hypervisor.h>
62 #include <xen/balloon.h>
63 #include <xen/events.h>
64 #include <xen/xenbus.h>
65 #include <xen/grant_table.h>
68 #include <xen/interface/grant_table.h>
69 #include <xen/interface/io/vscsiif.h>
71 #define DPRINTK(_f, _a...) \
72 pr_debug("(file=%s, line=%d) " _f, __FILE__ , __LINE__ , ## _a)
74 #define VSCSI_VERSION "v0.1"
75 #define VSCSI_NAMELEN 32
78 unsigned int hst; /* host */
79 unsigned int chn; /* channel */
80 unsigned int tgt; /* target */
81 unsigned int lun; /* LUN */
85 struct ids_tuple v; /* translate from */
86 struct scsiback_tpg *tpg; /* translate to */
93 struct xenbus_device *dev;
98 struct vscsiif_back_ring ring;
101 spinlock_t ring_lock;
102 atomic_t nr_unreplied_reqs;
105 struct list_head v2p_entry_lists;
107 wait_queue_head_t waiting_to_free;
110 /* theoretical maximum of grants for one request */
111 #define VSCSI_MAX_GRANTS (SG_ALL + VSCSIIF_SG_TABLESIZE)
114 * VSCSI_GRANT_BATCH is the maximum number of grants to be processed in one
115 * call to map/unmap grants. Don't choose it too large, as there are arrays
116 * with VSCSI_GRANT_BATCH elements allocated on the stack.
118 #define VSCSI_GRANT_BATCH 16
120 struct vscsibk_pend {
123 uint8_t cmnd[VSCSIIF_MAX_COMMAND_SIZE];
126 uint8_t sc_data_direction;
127 uint16_t n_sg; /* real length of SG list */
128 uint16_t n_grants; /* SG pages and potentially SG list */
132 struct vscsibk_info *info;
133 struct v2p_entry *v2p;
134 struct scatterlist *sgl;
136 uint8_t sense_buffer[VSCSIIF_SENSE_BUFFERSIZE];
138 grant_handle_t grant_handles[VSCSI_MAX_GRANTS];
139 struct page *pages[VSCSI_MAX_GRANTS];
141 struct se_cmd se_cmd;
144 struct scsiback_tmr {
145 atomic_t tmr_complete;
146 wait_queue_head_t tmr_wait;
149 struct scsiback_nexus {
150 /* Pointer to TCM session for I_T Nexus */
151 struct se_session *tvn_se_sess;
154 struct scsiback_tport {
155 /* SCSI protocol the tport is providing */
157 /* Binary World Wide unique Port Name for pvscsi Target port */
159 /* ASCII formatted WWPN for pvscsi Target port */
160 char tport_name[VSCSI_NAMELEN];
161 /* Returned by scsiback_make_tport() */
162 struct se_wwn tport_wwn;
165 struct scsiback_tpg {
166 /* scsiback port target portal group tag for TCM */
168 /* track number of TPG Port/Lun Links wrt explicit I_T Nexus shutdown */
169 int tv_tpg_port_count;
170 /* xen-pvscsi references to tpg_nexus, protected by tv_tpg_mutex */
172 /* list for scsiback_list */
173 struct list_head tv_tpg_list;
174 /* Used to protect access for tpg_nexus */
175 struct mutex tv_tpg_mutex;
176 /* Pointer to the TCM pvscsi I_T Nexus for this TPG endpoint */
177 struct scsiback_nexus *tpg_nexus;
178 /* Pointer back to scsiback_tport */
179 struct scsiback_tport *tport;
180 /* Returned by scsiback_make_tpg() */
181 struct se_portal_group se_tpg;
182 /* alias used in xenstore */
183 char param_alias[VSCSI_NAMELEN];
184 /* list of info structures related to this target portal group */
185 struct list_head info_list;
188 #define SCSIBACK_INVALID_HANDLE (~0)
190 static bool log_print_stat;
191 module_param(log_print_stat, bool, 0644);
193 static int scsiback_max_buffer_pages = 1024;
194 module_param_named(max_buffer_pages, scsiback_max_buffer_pages, int, 0644);
195 MODULE_PARM_DESC(max_buffer_pages,
196 "Maximum number of free pages to keep in backend buffer");
198 static struct kmem_cache *scsiback_cachep;
199 static DEFINE_SPINLOCK(free_pages_lock);
200 static int free_pages_num;
201 static LIST_HEAD(scsiback_free_pages);
203 /* Global spinlock to protect scsiback TPG list */
204 static DEFINE_MUTEX(scsiback_mutex);
205 static LIST_HEAD(scsiback_list);
207 /* Local pointer to allocated TCM configfs fabric module */
208 static struct target_fabric_configfs *scsiback_fabric_configfs;
210 static void scsiback_get(struct vscsibk_info *info)
212 atomic_inc(&info->nr_unreplied_reqs);
215 static void scsiback_put(struct vscsibk_info *info)
217 if (atomic_dec_and_test(&info->nr_unreplied_reqs))
218 wake_up(&info->waiting_to_free);
221 static void put_free_pages(struct page **page, int num)
224 int i = free_pages_num + num, n = num;
228 if (i > scsiback_max_buffer_pages) {
229 n = min(num, i - scsiback_max_buffer_pages);
230 free_xenballooned_pages(n, page + num - n);
233 spin_lock_irqsave(&free_pages_lock, flags);
234 for (i = 0; i < n; i++)
235 list_add(&page[i]->lru, &scsiback_free_pages);
237 spin_unlock_irqrestore(&free_pages_lock, flags);
240 static int get_free_page(struct page **page)
244 spin_lock_irqsave(&free_pages_lock, flags);
245 if (list_empty(&scsiback_free_pages)) {
246 spin_unlock_irqrestore(&free_pages_lock, flags);
247 return alloc_xenballooned_pages(1, page, false);
249 page[0] = list_first_entry(&scsiback_free_pages, struct page, lru);
250 list_del(&page[0]->lru);
252 spin_unlock_irqrestore(&free_pages_lock, flags);
256 static unsigned long vaddr_page(struct page *page)
258 unsigned long pfn = page_to_pfn(page);
260 return (unsigned long)pfn_to_kaddr(pfn);
263 static unsigned long vaddr(struct vscsibk_pend *req, int seg)
265 return vaddr_page(req->pages[seg]);
268 static void scsiback_print_status(char *sense_buffer, int errors,
269 struct vscsibk_pend *pending_req)
271 struct scsiback_tpg *tpg = pending_req->v2p->tpg;
273 pr_err("xen-pvscsi[%s:%d] cmnd[0]=%02x -> st=%02x msg=%02x host=%02x drv=%02x\n",
274 tpg->tport->tport_name, pending_req->v2p->lun,
275 pending_req->cmnd[0], status_byte(errors), msg_byte(errors),
276 host_byte(errors), driver_byte(errors));
278 if (CHECK_CONDITION & status_byte(errors))
279 __scsi_print_sense("xen-pvscsi", sense_buffer,
280 SCSI_SENSE_BUFFERSIZE);
283 static void scsiback_fast_flush_area(struct vscsibk_pend *req)
285 struct gnttab_unmap_grant_ref unmap[VSCSI_GRANT_BATCH];
286 struct page *pages[VSCSI_GRANT_BATCH];
287 unsigned int i, invcount = 0;
288 grant_handle_t handle;
298 for (i = 0; i < req->n_grants; i++) {
299 handle = req->grant_handles[i];
300 if (handle == SCSIBACK_INVALID_HANDLE)
302 gnttab_set_unmap_op(&unmap[invcount], vaddr(req, i),
303 GNTMAP_host_map, handle);
304 req->grant_handles[i] = SCSIBACK_INVALID_HANDLE;
305 pages[invcount] = req->pages[i];
306 put_page(pages[invcount]);
308 if (invcount < VSCSI_GRANT_BATCH)
310 err = gnttab_unmap_refs(unmap, NULL, pages, invcount);
316 err = gnttab_unmap_refs(unmap, NULL, pages, invcount);
320 put_free_pages(req->pages, req->n_grants);
324 static void scsiback_free_translation_entry(struct kref *kref)
326 struct v2p_entry *entry = container_of(kref, struct v2p_entry, kref);
327 struct scsiback_tpg *tpg = entry->tpg;
329 mutex_lock(&tpg->tv_tpg_mutex);
330 tpg->tv_tpg_fe_count--;
331 mutex_unlock(&tpg->tv_tpg_mutex);
336 static void scsiback_do_resp_with_sense(char *sense_buffer, int32_t result,
337 uint32_t resid, struct vscsibk_pend *pending_req)
339 struct vscsiif_response *ring_res;
340 struct vscsibk_info *info = pending_req->info;
342 struct scsi_sense_hdr sshdr;
346 spin_lock_irqsave(&info->ring_lock, flags);
348 ring_res = RING_GET_RESPONSE(&info->ring, info->ring.rsp_prod_pvt);
349 info->ring.rsp_prod_pvt++;
351 ring_res->rslt = result;
352 ring_res->rqid = pending_req->rqid;
354 if (sense_buffer != NULL &&
355 scsi_normalize_sense(sense_buffer, VSCSIIF_SENSE_BUFFERSIZE,
357 len = min_t(unsigned, 8 + sense_buffer[7],
358 VSCSIIF_SENSE_BUFFERSIZE);
359 memcpy(ring_res->sense_buffer, sense_buffer, len);
360 ring_res->sense_len = len;
362 ring_res->sense_len = 0;
365 ring_res->residual_len = resid;
367 RING_PUSH_RESPONSES_AND_CHECK_NOTIFY(&info->ring, notify);
368 spin_unlock_irqrestore(&info->ring_lock, flags);
371 notify_remote_via_irq(info->irq);
373 if (pending_req->v2p)
374 kref_put(&pending_req->v2p->kref,
375 scsiback_free_translation_entry);
378 static void scsiback_cmd_done(struct vscsibk_pend *pending_req)
380 struct vscsibk_info *info = pending_req->info;
381 unsigned char *sense_buffer;
385 sense_buffer = pending_req->sense_buffer;
386 resid = pending_req->se_cmd.residual_count;
387 errors = pending_req->result;
389 if (errors && log_print_stat)
390 scsiback_print_status(sense_buffer, errors, pending_req);
392 scsiback_fast_flush_area(pending_req);
393 scsiback_do_resp_with_sense(sense_buffer, errors, resid, pending_req);
397 static void scsiback_cmd_exec(struct vscsibk_pend *pending_req)
399 struct se_cmd *se_cmd = &pending_req->se_cmd;
400 struct se_session *sess = pending_req->v2p->tpg->tpg_nexus->tvn_se_sess;
403 memset(pending_req->sense_buffer, 0, VSCSIIF_SENSE_BUFFERSIZE);
405 memset(se_cmd, 0, sizeof(*se_cmd));
407 scsiback_get(pending_req->info);
408 rc = target_submit_cmd_map_sgls(se_cmd, sess, pending_req->cmnd,
409 pending_req->sense_buffer, pending_req->v2p->lun,
410 pending_req->data_len, 0,
411 pending_req->sc_data_direction, 0,
412 pending_req->sgl, pending_req->n_sg,
415 transport_send_check_condition_and_sense(se_cmd,
416 TCM_LOGICAL_UNIT_COMMUNICATION_FAILURE, 0);
417 transport_generic_free_cmd(se_cmd, 0);
421 static int scsiback_gnttab_data_map_batch(struct gnttab_map_grant_ref *map,
422 struct page **pg, grant_handle_t *grant, int cnt)
429 err = gnttab_map_refs(map, NULL, pg, cnt);
431 for (i = 0; i < cnt; i++) {
432 if (unlikely(map[i].status != GNTST_okay)) {
433 pr_err("xen-pvscsi: invalid buffer -- could not remap it\n");
434 map[i].handle = SCSIBACK_INVALID_HANDLE;
439 grant[i] = map[i].handle;
444 static int scsiback_gnttab_data_map_list(struct vscsibk_pend *pending_req,
445 struct scsiif_request_segment *seg, struct page **pg,
446 grant_handle_t *grant, int cnt, u32 flags)
448 int mapcount = 0, i, err = 0;
449 struct gnttab_map_grant_ref map[VSCSI_GRANT_BATCH];
450 struct vscsibk_info *info = pending_req->info;
452 for (i = 0; i < cnt; i++) {
453 if (get_free_page(pg + mapcount)) {
454 put_free_pages(pg, mapcount);
455 pr_err("xen-pvscsi: no grant page\n");
458 gnttab_set_map_op(&map[mapcount], vaddr_page(pg[mapcount]),
459 flags, seg[i].gref, info->domid);
461 if (mapcount < VSCSI_GRANT_BATCH)
463 err = scsiback_gnttab_data_map_batch(map, pg, grant, mapcount);
466 pending_req->n_grants += mapcount;
471 err = scsiback_gnttab_data_map_batch(map, pg, grant, mapcount);
472 pending_req->n_grants += mapcount;
476 static int scsiback_gnttab_data_map(struct vscsiif_request *ring_req,
477 struct vscsibk_pend *pending_req)
480 int i, err, n_segs, i_seg = 0;
482 struct scsiif_request_segment *seg;
483 unsigned long end_seg = 0;
484 unsigned int nr_segments = (unsigned int)ring_req->nr_segments;
485 unsigned int nr_sgl = 0;
486 struct scatterlist *sg;
487 grant_handle_t *grant;
489 pending_req->n_sg = 0;
490 pending_req->n_grants = 0;
491 pending_req->data_len = 0;
493 nr_segments &= ~VSCSIIF_SG_GRANT;
497 if (nr_segments > VSCSIIF_SG_TABLESIZE) {
498 DPRINTK("xen-pvscsi: invalid parameter nr_seg = %d\n",
499 ring_req->nr_segments);
503 if (ring_req->nr_segments & VSCSIIF_SG_GRANT) {
504 err = scsiback_gnttab_data_map_list(pending_req, ring_req->seg,
505 pending_req->pages, pending_req->grant_handles,
506 nr_segments, GNTMAP_host_map | GNTMAP_readonly);
509 nr_sgl = nr_segments;
511 for (i = 0; i < nr_sgl; i++) {
512 n_segs = ring_req->seg[i].length /
513 sizeof(struct scsiif_request_segment);
514 if ((unsigned)ring_req->seg[i].offset +
515 (unsigned)ring_req->seg[i].length > PAGE_SIZE ||
516 n_segs * sizeof(struct scsiif_request_segment) !=
517 ring_req->seg[i].length)
519 nr_segments += n_segs;
521 if (nr_segments > SG_ALL) {
522 DPRINTK("xen-pvscsi: invalid nr_seg = %d\n",
528 /* free of (sgl) in fast_flush_area()*/
529 pending_req->sgl = kmalloc_array(nr_segments,
530 sizeof(struct scatterlist), GFP_KERNEL);
531 if (!pending_req->sgl)
534 sg_init_table(pending_req->sgl, nr_segments);
535 pending_req->n_sg = nr_segments;
537 flags = GNTMAP_host_map;
538 if (pending_req->sc_data_direction == DMA_TO_DEVICE)
539 flags |= GNTMAP_readonly;
541 pg = pending_req->pages + nr_sgl;
542 grant = pending_req->grant_handles + nr_sgl;
545 err = scsiback_gnttab_data_map_list(pending_req, seg,
546 pg, grant, nr_segments, flags);
550 for (i = 0; i < nr_sgl; i++) {
551 seg = (struct scsiif_request_segment *)(
552 vaddr(pending_req, i) + ring_req->seg[i].offset);
553 n_segs = ring_req->seg[i].length /
554 sizeof(struct scsiif_request_segment);
555 err = scsiback_gnttab_data_map_list(pending_req, seg,
556 pg, grant, n_segs, flags);
562 end_seg = vaddr(pending_req, 0) + ring_req->seg[0].offset;
563 seg = (struct scsiif_request_segment *)end_seg;
564 end_seg += ring_req->seg[0].length;
565 pg = pending_req->pages + nr_sgl;
568 for_each_sg(pending_req->sgl, sg, nr_segments, i) {
569 sg_set_page(sg, pg[i], seg->length, seg->offset);
570 pending_req->data_len += seg->length;
572 if (nr_sgl && (unsigned long)seg >= end_seg) {
574 end_seg = vaddr(pending_req, i_seg) +
575 ring_req->seg[i_seg].offset;
576 seg = (struct scsiif_request_segment *)end_seg;
577 end_seg += ring_req->seg[i_seg].length;
579 if (sg->offset >= PAGE_SIZE ||
580 sg->length > PAGE_SIZE ||
581 sg->offset + sg->length > PAGE_SIZE)
588 static void scsiback_disconnect(struct vscsibk_info *info)
590 wait_event(info->waiting_to_free,
591 atomic_read(&info->nr_unreplied_reqs) == 0);
593 unbind_from_irqhandler(info->irq, info);
595 xenbus_unmap_ring_vfree(info->dev, info->ring.sring);
598 static void scsiback_device_action(struct vscsibk_pend *pending_req,
599 enum tcm_tmreq_table act, int tag)
601 int rc, err = FAILED;
602 struct scsiback_tpg *tpg = pending_req->v2p->tpg;
603 struct se_cmd *se_cmd = &pending_req->se_cmd;
604 struct scsiback_tmr *tmr;
606 tmr = kzalloc(sizeof(struct scsiback_tmr), GFP_KERNEL);
610 init_waitqueue_head(&tmr->tmr_wait);
612 transport_init_se_cmd(se_cmd, tpg->se_tpg.se_tpg_tfo,
613 tpg->tpg_nexus->tvn_se_sess, 0, DMA_NONE, MSG_SIMPLE_TAG,
614 &pending_req->sense_buffer[0]);
616 rc = core_tmr_alloc_req(se_cmd, tmr, act, GFP_KERNEL);
620 se_cmd->se_tmr_req->ref_task_tag = tag;
622 if (transport_lookup_tmr_lun(se_cmd, pending_req->v2p->lun) < 0)
625 transport_generic_handle_tmr(se_cmd);
626 wait_event(tmr->tmr_wait, atomic_read(&tmr->tmr_complete));
628 err = (se_cmd->se_tmr_req->response == TMR_FUNCTION_COMPLETE) ?
633 transport_generic_free_cmd(&pending_req->se_cmd, 1);
637 scsiback_do_resp_with_sense(NULL, err, 0, pending_req);
639 kmem_cache_free(scsiback_cachep, pending_req);
643 Perform virtual to physical translation
645 static struct v2p_entry *scsiback_do_translation(struct vscsibk_info *info,
648 struct v2p_entry *entry;
649 struct list_head *head = &(info->v2p_entry_lists);
652 spin_lock_irqsave(&info->v2p_lock, flags);
653 list_for_each_entry(entry, head, l) {
654 if ((entry->v.chn == v->chn) &&
655 (entry->v.tgt == v->tgt) &&
656 (entry->v.lun == v->lun)) {
657 kref_get(&entry->kref);
664 spin_unlock_irqrestore(&info->v2p_lock, flags);
668 static int prepare_pending_reqs(struct vscsibk_info *info,
669 struct vscsiif_request *ring_req,
670 struct vscsibk_pend *pending_req)
672 struct v2p_entry *v2p;
673 struct ids_tuple vir;
675 pending_req->rqid = ring_req->rqid;
676 pending_req->info = info;
678 vir.chn = ring_req->channel;
679 vir.tgt = ring_req->id;
680 vir.lun = ring_req->lun;
682 v2p = scsiback_do_translation(info, &vir);
684 pending_req->v2p = NULL;
685 DPRINTK("xen-pvscsi: doesn't exist.\n");
688 pending_req->v2p = v2p;
690 /* request range check from frontend */
691 pending_req->sc_data_direction = ring_req->sc_data_direction;
692 if ((pending_req->sc_data_direction != DMA_BIDIRECTIONAL) &&
693 (pending_req->sc_data_direction != DMA_TO_DEVICE) &&
694 (pending_req->sc_data_direction != DMA_FROM_DEVICE) &&
695 (pending_req->sc_data_direction != DMA_NONE)) {
696 DPRINTK("xen-pvscsi: invalid parameter data_dir = %d\n",
697 pending_req->sc_data_direction);
701 pending_req->cmd_len = ring_req->cmd_len;
702 if (pending_req->cmd_len > VSCSIIF_MAX_COMMAND_SIZE) {
703 DPRINTK("xen-pvscsi: invalid parameter cmd_len = %d\n",
704 pending_req->cmd_len);
707 memcpy(pending_req->cmnd, ring_req->cmnd, pending_req->cmd_len);
712 static int scsiback_do_cmd_fn(struct vscsibk_info *info)
714 struct vscsiif_back_ring *ring = &info->ring;
715 struct vscsiif_request *ring_req;
716 struct vscsibk_pend *pending_req;
723 rp = ring->sring->req_prod;
724 rmb(); /* guest system is accessing ring, too */
726 if (RING_REQUEST_PROD_OVERFLOW(ring, rp)) {
727 rc = ring->rsp_prod_pvt;
728 pr_warn("xen-pvscsi: Dom%d provided bogus ring requests (%#x - %#x = %u). Halting ring processing\n",
729 info->domid, rp, rc, rp - rc);
730 info->ring_error = 1;
735 if (RING_REQUEST_CONS_OVERFLOW(ring, rc))
737 pending_req = kmem_cache_alloc(scsiback_cachep, GFP_KERNEL);
741 ring_req = RING_GET_REQUEST(ring, rc);
742 ring->req_cons = ++rc;
745 err = prepare_pending_reqs(info, ring_req, pending_req);
749 result = DID_NO_CONNECT;
752 result = DRIVER_ERROR;
755 scsiback_do_resp_with_sense(NULL, result << 24, 0,
757 kmem_cache_free(scsiback_cachep, pending_req);
762 case VSCSIIF_ACT_SCSI_CDB:
763 if (scsiback_gnttab_data_map(ring_req, pending_req)) {
764 scsiback_fast_flush_area(pending_req);
765 scsiback_do_resp_with_sense(NULL,
766 DRIVER_ERROR << 24, 0, pending_req);
767 kmem_cache_free(scsiback_cachep, pending_req);
769 scsiback_cmd_exec(pending_req);
772 case VSCSIIF_ACT_SCSI_ABORT:
773 scsiback_device_action(pending_req, TMR_ABORT_TASK,
776 case VSCSIIF_ACT_SCSI_RESET:
777 scsiback_device_action(pending_req, TMR_LUN_RESET, 0);
780 pr_err_ratelimited("xen-pvscsi: invalid request\n");
781 scsiback_do_resp_with_sense(NULL, DRIVER_ERROR << 24,
783 kmem_cache_free(scsiback_cachep, pending_req);
787 /* Yield point for this unbounded loop. */
791 RING_FINAL_CHECK_FOR_REQUESTS(&info->ring, more_to_do);
795 static irqreturn_t scsiback_irq_fn(int irq, void *dev_id)
797 struct vscsibk_info *info = dev_id;
799 if (info->ring_error)
802 while (scsiback_do_cmd_fn(info))
808 static int scsiback_init_sring(struct vscsibk_info *info, grant_ref_t ring_ref,
809 evtchn_port_t evtchn)
812 struct vscsiif_sring *sring;
818 err = xenbus_map_ring_valloc(info->dev, ring_ref, &area);
822 sring = (struct vscsiif_sring *)area;
823 BACK_RING_INIT(&info->ring, sring, PAGE_SIZE);
825 err = bind_interdomain_evtchn_to_irq(info->domid, evtchn);
831 err = request_threaded_irq(info->irq, NULL, scsiback_irq_fn,
832 IRQF_ONESHOT, "vscsiif-backend", info);
839 unbind_from_irqhandler(info->irq, info);
842 xenbus_unmap_ring_vfree(info->dev, area);
847 static int scsiback_map(struct vscsibk_info *info)
849 struct xenbus_device *dev = info->dev;
850 unsigned int ring_ref, evtchn;
853 err = xenbus_gather(XBT_NIL, dev->otherend,
854 "ring-ref", "%u", &ring_ref,
855 "event-channel", "%u", &evtchn, NULL);
857 xenbus_dev_fatal(dev, err, "reading %s ring", dev->otherend);
861 return scsiback_init_sring(info, ring_ref, evtchn);
865 Add a new translation entry
867 static int scsiback_add_translation_entry(struct vscsibk_info *info,
868 char *phy, struct ids_tuple *v)
871 struct v2p_entry *entry;
872 struct v2p_entry *new;
873 struct list_head *head = &(info->v2p_entry_lists);
877 struct scsiback_tpg *tpg_entry, *tpg = NULL;
878 char *error = "doesn't exist";
880 lunp = strrchr(phy, ':');
882 pr_err("xen-pvscsi: illegal format of physical device %s\n",
888 if (kstrtouint(lunp, 10, &lun) || lun >= TRANSPORT_MAX_LUNS_PER_TPG) {
889 pr_err("xen-pvscsi: lun number not valid: %s\n", lunp);
893 mutex_lock(&scsiback_mutex);
894 list_for_each_entry(tpg_entry, &scsiback_list, tv_tpg_list) {
895 if (!strcmp(phy, tpg_entry->tport->tport_name) ||
896 !strcmp(phy, tpg_entry->param_alias)) {
897 spin_lock(&tpg_entry->se_tpg.tpg_lun_lock);
898 if (tpg_entry->se_tpg.tpg_lun_list[lun]->lun_status ==
899 TRANSPORT_LUN_STATUS_ACTIVE) {
900 if (!tpg_entry->tpg_nexus)
901 error = "nexus undefined";
905 spin_unlock(&tpg_entry->se_tpg.tpg_lun_lock);
910 mutex_lock(&tpg->tv_tpg_mutex);
911 tpg->tv_tpg_fe_count++;
912 mutex_unlock(&tpg->tv_tpg_mutex);
914 mutex_unlock(&scsiback_mutex);
917 pr_err("xen-pvscsi: %s:%d %s\n", phy, lun, error);
921 new = kmalloc(sizeof(struct v2p_entry), GFP_KERNEL);
927 spin_lock_irqsave(&info->v2p_lock, flags);
929 /* Check double assignment to identical virtual ID */
930 list_for_each_entry(entry, head, l) {
931 if ((entry->v.chn == v->chn) &&
932 (entry->v.tgt == v->tgt) &&
933 (entry->v.lun == v->lun)) {
934 pr_warn("xen-pvscsi: Virtual ID is already used. Assignment was not performed.\n");
941 /* Create a new translation entry and add to the list */
942 kref_init(&new->kref);
946 list_add_tail(&new->l, head);
949 spin_unlock_irqrestore(&info->v2p_lock, flags);
952 mutex_lock(&tpg->tv_tpg_mutex);
953 tpg->tv_tpg_fe_count--;
954 mutex_unlock(&tpg->tv_tpg_mutex);
962 static void __scsiback_del_translation_entry(struct v2p_entry *entry)
965 kref_put(&entry->kref, scsiback_free_translation_entry);
969 Delete the translation entry specfied
971 static int scsiback_del_translation_entry(struct vscsibk_info *info,
974 struct v2p_entry *entry;
975 struct list_head *head = &(info->v2p_entry_lists);
978 spin_lock_irqsave(&info->v2p_lock, flags);
979 /* Find out the translation entry specified */
980 list_for_each_entry(entry, head, l) {
981 if ((entry->v.chn == v->chn) &&
982 (entry->v.tgt == v->tgt) &&
983 (entry->v.lun == v->lun)) {
988 spin_unlock_irqrestore(&info->v2p_lock, flags);
992 /* Delete the translation entry specfied */
993 __scsiback_del_translation_entry(entry);
995 spin_unlock_irqrestore(&info->v2p_lock, flags);
999 static void scsiback_do_add_lun(struct vscsibk_info *info, const char *state,
1000 char *phy, struct ids_tuple *vir)
1002 if (!scsiback_add_translation_entry(info, phy, vir)) {
1003 if (xenbus_printf(XBT_NIL, info->dev->nodename, state,
1004 "%d", XenbusStateInitialised)) {
1005 pr_err("xen-pvscsi: xenbus_printf error %s\n", state);
1006 scsiback_del_translation_entry(info, vir);
1009 xenbus_printf(XBT_NIL, info->dev->nodename, state,
1010 "%d", XenbusStateClosed);
1014 static void scsiback_do_del_lun(struct vscsibk_info *info, const char *state,
1015 struct ids_tuple *vir)
1017 if (!scsiback_del_translation_entry(info, vir)) {
1018 if (xenbus_printf(XBT_NIL, info->dev->nodename, state,
1019 "%d", XenbusStateClosed))
1020 pr_err("xen-pvscsi: xenbus_printf error %s\n", state);
1024 #define VSCSIBACK_OP_ADD_OR_DEL_LUN 1
1025 #define VSCSIBACK_OP_UPDATEDEV_STATE 2
1027 static void scsiback_do_1lun_hotplug(struct vscsibk_info *info, int op,
1031 struct ids_tuple vir;
1034 char phy[VSCSI_NAMELEN];
1037 struct xenbus_device *dev = info->dev;
1040 snprintf(state, sizeof(state), "vscsi-devs/%s/state", ent);
1041 err = xenbus_scanf(XBT_NIL, dev->nodename, state, "%u", &device_state);
1042 if (XENBUS_EXIST_ERR(err))
1045 /* physical SCSI device */
1046 snprintf(str, sizeof(str), "vscsi-devs/%s/p-dev", ent);
1047 val = xenbus_read(XBT_NIL, dev->nodename, str, NULL);
1049 xenbus_printf(XBT_NIL, dev->nodename, state,
1050 "%d", XenbusStateClosed);
1053 strlcpy(phy, val, VSCSI_NAMELEN);
1056 /* virtual SCSI device */
1057 snprintf(str, sizeof(str), "vscsi-devs/%s/v-dev", ent);
1058 err = xenbus_scanf(XBT_NIL, dev->nodename, str, "%u:%u:%u:%u",
1059 &vir.hst, &vir.chn, &vir.tgt, &vir.lun);
1060 if (XENBUS_EXIST_ERR(err)) {
1061 xenbus_printf(XBT_NIL, dev->nodename, state,
1062 "%d", XenbusStateClosed);
1067 case VSCSIBACK_OP_ADD_OR_DEL_LUN:
1068 if (device_state == XenbusStateInitialising)
1069 scsiback_do_add_lun(info, state, phy, &vir);
1070 if (device_state == XenbusStateClosing)
1071 scsiback_do_del_lun(info, state, &vir);
1074 case VSCSIBACK_OP_UPDATEDEV_STATE:
1075 if (device_state == XenbusStateInitialised) {
1076 /* modify vscsi-devs/dev-x/state */
1077 if (xenbus_printf(XBT_NIL, dev->nodename, state,
1078 "%d", XenbusStateConnected)) {
1079 pr_err("xen-pvscsi: xenbus_printf error %s\n",
1081 scsiback_del_translation_entry(info, &vir);
1082 xenbus_printf(XBT_NIL, dev->nodename, state,
1083 "%d", XenbusStateClosed);
1087 /*When it is necessary, processing is added here.*/
1093 static void scsiback_do_lun_hotplug(struct vscsibk_info *info, int op)
1097 unsigned int ndir = 0;
1099 dir = xenbus_directory(XBT_NIL, info->dev->nodename, "vscsi-devs",
1104 for (i = 0; i < ndir; i++)
1105 scsiback_do_1lun_hotplug(info, op, dir[i]);
1110 static void scsiback_frontend_changed(struct xenbus_device *dev,
1111 enum xenbus_state frontend_state)
1113 struct vscsibk_info *info = dev_get_drvdata(&dev->dev);
1115 switch (frontend_state) {
1116 case XenbusStateInitialising:
1119 case XenbusStateInitialised:
1120 if (scsiback_map(info))
1123 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_ADD_OR_DEL_LUN);
1124 xenbus_switch_state(dev, XenbusStateConnected);
1127 case XenbusStateConnected:
1128 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_UPDATEDEV_STATE);
1130 if (dev->state == XenbusStateConnected)
1133 xenbus_switch_state(dev, XenbusStateConnected);
1136 case XenbusStateClosing:
1138 scsiback_disconnect(info);
1140 xenbus_switch_state(dev, XenbusStateClosing);
1143 case XenbusStateClosed:
1144 xenbus_switch_state(dev, XenbusStateClosed);
1145 if (xenbus_dev_is_online(dev))
1147 /* fall through if not online */
1148 case XenbusStateUnknown:
1149 device_unregister(&dev->dev);
1152 case XenbusStateReconfiguring:
1153 scsiback_do_lun_hotplug(info, VSCSIBACK_OP_ADD_OR_DEL_LUN);
1154 xenbus_switch_state(dev, XenbusStateReconfigured);
1159 xenbus_dev_fatal(dev, -EINVAL, "saw state %d at frontend",
1166 Release the translation entry specfied
1168 static void scsiback_release_translation_entry(struct vscsibk_info *info)
1170 struct v2p_entry *entry, *tmp;
1171 struct list_head *head = &(info->v2p_entry_lists);
1172 unsigned long flags;
1174 spin_lock_irqsave(&info->v2p_lock, flags);
1176 list_for_each_entry_safe(entry, tmp, head, l)
1177 __scsiback_del_translation_entry(entry);
1179 spin_unlock_irqrestore(&info->v2p_lock, flags);
1182 static int scsiback_remove(struct xenbus_device *dev)
1184 struct vscsibk_info *info = dev_get_drvdata(&dev->dev);
1187 scsiback_disconnect(info);
1189 scsiback_release_translation_entry(info);
1191 dev_set_drvdata(&dev->dev, NULL);
1196 static int scsiback_probe(struct xenbus_device *dev,
1197 const struct xenbus_device_id *id)
1201 struct vscsibk_info *info = kzalloc(sizeof(struct vscsibk_info),
1204 DPRINTK("%p %d\n", dev, dev->otherend_id);
1207 xenbus_dev_fatal(dev, -ENOMEM, "allocating backend structure");
1211 dev_set_drvdata(&dev->dev, info);
1213 info->domid = dev->otherend_id;
1214 spin_lock_init(&info->ring_lock);
1215 info->ring_error = 0;
1216 atomic_set(&info->nr_unreplied_reqs, 0);
1217 init_waitqueue_head(&info->waiting_to_free);
1220 INIT_LIST_HEAD(&info->v2p_entry_lists);
1221 spin_lock_init(&info->v2p_lock);
1223 err = xenbus_printf(XBT_NIL, dev->nodename, "feature-sg-grant", "%u",
1226 xenbus_dev_error(dev, err, "writing feature-sg-grant");
1228 err = xenbus_switch_state(dev, XenbusStateInitWait);
1235 pr_warn("xen-pvscsi: %s failed\n", __func__);
1236 scsiback_remove(dev);
1241 static char *scsiback_dump_proto_id(struct scsiback_tport *tport)
1243 switch (tport->tport_proto_id) {
1244 case SCSI_PROTOCOL_SAS:
1246 case SCSI_PROTOCOL_FCP:
1248 case SCSI_PROTOCOL_ISCSI:
1257 static u8 scsiback_get_fabric_proto_ident(struct se_portal_group *se_tpg)
1259 struct scsiback_tpg *tpg = container_of(se_tpg,
1260 struct scsiback_tpg, se_tpg);
1261 struct scsiback_tport *tport = tpg->tport;
1263 switch (tport->tport_proto_id) {
1264 case SCSI_PROTOCOL_SAS:
1265 return sas_get_fabric_proto_ident(se_tpg);
1266 case SCSI_PROTOCOL_FCP:
1267 return fc_get_fabric_proto_ident(se_tpg);
1268 case SCSI_PROTOCOL_ISCSI:
1269 return iscsi_get_fabric_proto_ident(se_tpg);
1271 pr_err("Unknown tport_proto_id: 0x%02x, using SAS emulation\n",
1272 tport->tport_proto_id);
1276 return sas_get_fabric_proto_ident(se_tpg);
1279 static char *scsiback_get_fabric_wwn(struct se_portal_group *se_tpg)
1281 struct scsiback_tpg *tpg = container_of(se_tpg,
1282 struct scsiback_tpg, se_tpg);
1283 struct scsiback_tport *tport = tpg->tport;
1285 return &tport->tport_name[0];
1288 static u16 scsiback_get_tag(struct se_portal_group *se_tpg)
1290 struct scsiback_tpg *tpg = container_of(se_tpg,
1291 struct scsiback_tpg, se_tpg);
1292 return tpg->tport_tpgt;
1295 static u32 scsiback_get_default_depth(struct se_portal_group *se_tpg)
1301 scsiback_get_pr_transport_id(struct se_portal_group *se_tpg,
1302 struct se_node_acl *se_nacl,
1303 struct t10_pr_registration *pr_reg,
1307 struct scsiback_tpg *tpg = container_of(se_tpg,
1308 struct scsiback_tpg, se_tpg);
1309 struct scsiback_tport *tport = tpg->tport;
1311 switch (tport->tport_proto_id) {
1312 case SCSI_PROTOCOL_SAS:
1313 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
1315 case SCSI_PROTOCOL_FCP:
1316 return fc_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
1318 case SCSI_PROTOCOL_ISCSI:
1319 return iscsi_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
1322 pr_err("Unknown tport_proto_id: 0x%02x, using SAS emulation\n",
1323 tport->tport_proto_id);
1327 return sas_get_pr_transport_id(se_tpg, se_nacl, pr_reg,
1332 scsiback_get_pr_transport_id_len(struct se_portal_group *se_tpg,
1333 struct se_node_acl *se_nacl,
1334 struct t10_pr_registration *pr_reg,
1337 struct scsiback_tpg *tpg = container_of(se_tpg,
1338 struct scsiback_tpg, se_tpg);
1339 struct scsiback_tport *tport = tpg->tport;
1341 switch (tport->tport_proto_id) {
1342 case SCSI_PROTOCOL_SAS:
1343 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
1345 case SCSI_PROTOCOL_FCP:
1346 return fc_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
1348 case SCSI_PROTOCOL_ISCSI:
1349 return iscsi_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
1352 pr_err("Unknown tport_proto_id: 0x%02x, using SAS emulation\n",
1353 tport->tport_proto_id);
1357 return sas_get_pr_transport_id_len(se_tpg, se_nacl, pr_reg,
1362 scsiback_parse_pr_out_transport_id(struct se_portal_group *se_tpg,
1365 char **port_nexus_ptr)
1367 struct scsiback_tpg *tpg = container_of(se_tpg,
1368 struct scsiback_tpg, se_tpg);
1369 struct scsiback_tport *tport = tpg->tport;
1371 switch (tport->tport_proto_id) {
1372 case SCSI_PROTOCOL_SAS:
1373 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
1375 case SCSI_PROTOCOL_FCP:
1376 return fc_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
1378 case SCSI_PROTOCOL_ISCSI:
1379 return iscsi_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
1382 pr_err("Unknown tport_proto_id: 0x%02x, using SAS emulation\n",
1383 tport->tport_proto_id);
1387 return sas_parse_pr_out_transport_id(se_tpg, buf, out_tid_len,
1391 static struct se_wwn *
1392 scsiback_make_tport(struct target_fabric_configfs *tf,
1393 struct config_group *group,
1396 struct scsiback_tport *tport;
1401 tport = kzalloc(sizeof(struct scsiback_tport), GFP_KERNEL);
1403 return ERR_PTR(-ENOMEM);
1405 tport->tport_wwpn = wwpn;
1407 * Determine the emulated Protocol Identifier and Target Port Name
1408 * based on the incoming configfs directory name.
1410 ptr = strstr(name, "naa.");
1412 tport->tport_proto_id = SCSI_PROTOCOL_SAS;
1415 ptr = strstr(name, "fc.");
1417 tport->tport_proto_id = SCSI_PROTOCOL_FCP;
1418 off = 3; /* Skip over "fc." */
1421 ptr = strstr(name, "iqn.");
1423 tport->tport_proto_id = SCSI_PROTOCOL_ISCSI;
1427 pr_err("Unable to locate prefix for emulated Target Port: %s\n", name);
1429 return ERR_PTR(-EINVAL);
1432 if (strlen(name) >= VSCSI_NAMELEN) {
1433 pr_err("Emulated %s Address: %s, exceeds max: %d\n", name,
1434 scsiback_dump_proto_id(tport), VSCSI_NAMELEN);
1436 return ERR_PTR(-EINVAL);
1438 snprintf(&tport->tport_name[0], VSCSI_NAMELEN, "%s", &name[off]);
1440 pr_debug("xen-pvscsi: Allocated emulated Target %s Address: %s\n",
1441 scsiback_dump_proto_id(tport), name);
1443 return &tport->tport_wwn;
1446 static void scsiback_drop_tport(struct se_wwn *wwn)
1448 struct scsiback_tport *tport = container_of(wwn,
1449 struct scsiback_tport, tport_wwn);
1451 pr_debug("xen-pvscsi: Deallocating emulated Target %s Address: %s\n",
1452 scsiback_dump_proto_id(tport), tport->tport_name);
1457 static struct se_node_acl *
1458 scsiback_alloc_fabric_acl(struct se_portal_group *se_tpg)
1460 return kzalloc(sizeof(struct se_node_acl), GFP_KERNEL);
1464 scsiback_release_fabric_acl(struct se_portal_group *se_tpg,
1465 struct se_node_acl *se_nacl)
1470 static u32 scsiback_tpg_get_inst_index(struct se_portal_group *se_tpg)
1475 static int scsiback_check_stop_free(struct se_cmd *se_cmd)
1478 * Do not release struct se_cmd's containing a valid TMR
1479 * pointer. These will be released directly in scsiback_device_action()
1480 * with transport_generic_free_cmd().
1482 if (se_cmd->se_cmd_flags & SCF_SCSI_TMR_CDB)
1485 transport_generic_free_cmd(se_cmd, 0);
1489 static void scsiback_release_cmd(struct se_cmd *se_cmd)
1491 struct vscsibk_pend *pending_req = container_of(se_cmd,
1492 struct vscsibk_pend, se_cmd);
1494 kmem_cache_free(scsiback_cachep, pending_req);
1497 static int scsiback_shutdown_session(struct se_session *se_sess)
1502 static void scsiback_close_session(struct se_session *se_sess)
1506 static u32 scsiback_sess_get_index(struct se_session *se_sess)
1511 static int scsiback_write_pending(struct se_cmd *se_cmd)
1513 /* Go ahead and process the write immediately */
1514 target_execute_cmd(se_cmd);
1519 static int scsiback_write_pending_status(struct se_cmd *se_cmd)
1524 static void scsiback_set_default_node_attrs(struct se_node_acl *nacl)
1528 static u32 scsiback_get_task_tag(struct se_cmd *se_cmd)
1530 struct vscsibk_pend *pending_req = container_of(se_cmd,
1531 struct vscsibk_pend, se_cmd);
1533 return pending_req->rqid;
1536 static int scsiback_get_cmd_state(struct se_cmd *se_cmd)
1541 static int scsiback_queue_data_in(struct se_cmd *se_cmd)
1543 struct vscsibk_pend *pending_req = container_of(se_cmd,
1544 struct vscsibk_pend, se_cmd);
1546 pending_req->result = SAM_STAT_GOOD;
1547 scsiback_cmd_done(pending_req);
1551 static int scsiback_queue_status(struct se_cmd *se_cmd)
1553 struct vscsibk_pend *pending_req = container_of(se_cmd,
1554 struct vscsibk_pend, se_cmd);
1556 if (se_cmd->sense_buffer &&
1557 ((se_cmd->se_cmd_flags & SCF_TRANSPORT_TASK_SENSE) ||
1558 (se_cmd->se_cmd_flags & SCF_EMULATED_TASK_SENSE)))
1559 pending_req->result = (DRIVER_SENSE << 24) |
1560 SAM_STAT_CHECK_CONDITION;
1562 pending_req->result = se_cmd->scsi_status;
1564 scsiback_cmd_done(pending_req);
1568 static void scsiback_queue_tm_rsp(struct se_cmd *se_cmd)
1570 struct se_tmr_req *se_tmr = se_cmd->se_tmr_req;
1571 struct scsiback_tmr *tmr = se_tmr->fabric_tmr_ptr;
1573 atomic_set(&tmr->tmr_complete, 1);
1574 wake_up(&tmr->tmr_wait);
1577 static void scsiback_aborted_task(struct se_cmd *se_cmd)
1581 static ssize_t scsiback_tpg_param_show_alias(struct se_portal_group *se_tpg,
1584 struct scsiback_tpg *tpg = container_of(se_tpg, struct scsiback_tpg,
1588 mutex_lock(&tpg->tv_tpg_mutex);
1589 rb = snprintf(page, PAGE_SIZE, "%s\n", tpg->param_alias);
1590 mutex_unlock(&tpg->tv_tpg_mutex);
1595 static ssize_t scsiback_tpg_param_store_alias(struct se_portal_group *se_tpg,
1596 const char *page, size_t count)
1598 struct scsiback_tpg *tpg = container_of(se_tpg, struct scsiback_tpg,
1602 if (strlen(page) >= VSCSI_NAMELEN) {
1603 pr_err("param alias: %s, exceeds max: %d\n", page,
1608 mutex_lock(&tpg->tv_tpg_mutex);
1609 len = snprintf(tpg->param_alias, VSCSI_NAMELEN, "%s", page);
1610 if (tpg->param_alias[len - 1] == '\n')
1611 tpg->param_alias[len - 1] = '\0';
1612 mutex_unlock(&tpg->tv_tpg_mutex);
1617 TF_TPG_PARAM_ATTR(scsiback, alias, S_IRUGO | S_IWUSR);
1619 static struct configfs_attribute *scsiback_param_attrs[] = {
1620 &scsiback_tpg_param_alias.attr,
1624 static int scsiback_make_nexus(struct scsiback_tpg *tpg,
1627 struct se_portal_group *se_tpg;
1628 struct se_session *se_sess;
1629 struct scsiback_nexus *tv_nexus;
1631 mutex_lock(&tpg->tv_tpg_mutex);
1632 if (tpg->tpg_nexus) {
1633 mutex_unlock(&tpg->tv_tpg_mutex);
1634 pr_debug("tpg->tpg_nexus already exists\n");
1637 se_tpg = &tpg->se_tpg;
1639 tv_nexus = kzalloc(sizeof(struct scsiback_nexus), GFP_KERNEL);
1641 mutex_unlock(&tpg->tv_tpg_mutex);
1645 * Initialize the struct se_session pointer
1647 tv_nexus->tvn_se_sess = transport_init_session(TARGET_PROT_NORMAL);
1648 if (IS_ERR(tv_nexus->tvn_se_sess)) {
1649 mutex_unlock(&tpg->tv_tpg_mutex);
1653 se_sess = tv_nexus->tvn_se_sess;
1655 * Since we are running in 'demo mode' this call with generate a
1656 * struct se_node_acl for the scsiback struct se_portal_group with
1657 * the SCSI Initiator port name of the passed configfs group 'name'.
1659 tv_nexus->tvn_se_sess->se_node_acl = core_tpg_check_initiator_node_acl(
1660 se_tpg, (unsigned char *)name);
1661 if (!tv_nexus->tvn_se_sess->se_node_acl) {
1662 mutex_unlock(&tpg->tv_tpg_mutex);
1663 pr_debug("core_tpg_check_initiator_node_acl() failed for %s\n",
1668 * Now register the TCM pvscsi virtual I_T Nexus as active with the
1669 * call to __transport_register_session()
1671 __transport_register_session(se_tpg, tv_nexus->tvn_se_sess->se_node_acl,
1672 tv_nexus->tvn_se_sess, tv_nexus);
1673 tpg->tpg_nexus = tv_nexus;
1675 mutex_unlock(&tpg->tv_tpg_mutex);
1679 transport_free_session(se_sess);
1684 static int scsiback_drop_nexus(struct scsiback_tpg *tpg)
1686 struct se_session *se_sess;
1687 struct scsiback_nexus *tv_nexus;
1689 mutex_lock(&tpg->tv_tpg_mutex);
1690 tv_nexus = tpg->tpg_nexus;
1692 mutex_unlock(&tpg->tv_tpg_mutex);
1696 se_sess = tv_nexus->tvn_se_sess;
1698 mutex_unlock(&tpg->tv_tpg_mutex);
1702 if (tpg->tv_tpg_port_count != 0) {
1703 mutex_unlock(&tpg->tv_tpg_mutex);
1704 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG port count: %d\n",
1705 tpg->tv_tpg_port_count);
1709 if (tpg->tv_tpg_fe_count != 0) {
1710 mutex_unlock(&tpg->tv_tpg_mutex);
1711 pr_err("Unable to remove xen-pvscsi I_T Nexus with active TPG frontend count: %d\n",
1712 tpg->tv_tpg_fe_count);
1716 pr_debug("xen-pvscsi: Removing I_T Nexus to emulated %s Initiator Port: %s\n",
1717 scsiback_dump_proto_id(tpg->tport),
1718 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1721 * Release the SCSI I_T Nexus to the emulated xen-pvscsi Target Port
1723 transport_deregister_session(tv_nexus->tvn_se_sess);
1724 tpg->tpg_nexus = NULL;
1725 mutex_unlock(&tpg->tv_tpg_mutex);
1731 static ssize_t scsiback_tpg_show_nexus(struct se_portal_group *se_tpg,
1734 struct scsiback_tpg *tpg = container_of(se_tpg,
1735 struct scsiback_tpg, se_tpg);
1736 struct scsiback_nexus *tv_nexus;
1739 mutex_lock(&tpg->tv_tpg_mutex);
1740 tv_nexus = tpg->tpg_nexus;
1742 mutex_unlock(&tpg->tv_tpg_mutex);
1745 ret = snprintf(page, PAGE_SIZE, "%s\n",
1746 tv_nexus->tvn_se_sess->se_node_acl->initiatorname);
1747 mutex_unlock(&tpg->tv_tpg_mutex);
1752 static ssize_t scsiback_tpg_store_nexus(struct se_portal_group *se_tpg,
1756 struct scsiback_tpg *tpg = container_of(se_tpg,
1757 struct scsiback_tpg, se_tpg);
1758 struct scsiback_tport *tport_wwn = tpg->tport;
1759 unsigned char i_port[VSCSI_NAMELEN], *ptr, *port_ptr;
1762 * Shutdown the active I_T nexus if 'NULL' is passed..
1764 if (!strncmp(page, "NULL", 4)) {
1765 ret = scsiback_drop_nexus(tpg);
1766 return (!ret) ? count : ret;
1769 * Otherwise make sure the passed virtual Initiator port WWN matches
1770 * the fabric protocol_id set in scsiback_make_tport(), and call
1771 * scsiback_make_nexus().
1773 if (strlen(page) >= VSCSI_NAMELEN) {
1774 pr_err("Emulated NAA Sas Address: %s, exceeds max: %d\n",
1775 page, VSCSI_NAMELEN);
1778 snprintf(&i_port[0], VSCSI_NAMELEN, "%s", page);
1780 ptr = strstr(i_port, "naa.");
1782 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_SAS) {
1783 pr_err("Passed SAS Initiator Port %s does not match target port protoid: %s\n",
1784 i_port, scsiback_dump_proto_id(tport_wwn));
1787 port_ptr = &i_port[0];
1790 ptr = strstr(i_port, "fc.");
1792 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_FCP) {
1793 pr_err("Passed FCP Initiator Port %s does not match target port protoid: %s\n",
1794 i_port, scsiback_dump_proto_id(tport_wwn));
1797 port_ptr = &i_port[3]; /* Skip over "fc." */
1800 ptr = strstr(i_port, "iqn.");
1802 if (tport_wwn->tport_proto_id != SCSI_PROTOCOL_ISCSI) {
1803 pr_err("Passed iSCSI Initiator Port %s does not match target port protoid: %s\n",
1804 i_port, scsiback_dump_proto_id(tport_wwn));
1807 port_ptr = &i_port[0];
1810 pr_err("Unable to locate prefix for emulated Initiator Port: %s\n",
1814 * Clear any trailing newline for the NAA WWN
1817 if (i_port[strlen(i_port) - 1] == '\n')
1818 i_port[strlen(i_port) - 1] = '\0';
1820 ret = scsiback_make_nexus(tpg, port_ptr);
1827 TF_TPG_BASE_ATTR(scsiback, nexus, S_IRUGO | S_IWUSR);
1829 static struct configfs_attribute *scsiback_tpg_attrs[] = {
1830 &scsiback_tpg_nexus.attr,
1835 scsiback_wwn_show_attr_version(struct target_fabric_configfs *tf,
1838 return sprintf(page, "xen-pvscsi fabric module %s on %s/%s on "
1840 VSCSI_VERSION, utsname()->sysname, utsname()->machine);
1843 TF_WWN_ATTR_RO(scsiback, version);
1845 static struct configfs_attribute *scsiback_wwn_attrs[] = {
1846 &scsiback_wwn_version.attr,
1850 static char *scsiback_get_fabric_name(void)
1852 return "xen-pvscsi";
1855 static int scsiback_port_link(struct se_portal_group *se_tpg,
1858 struct scsiback_tpg *tpg = container_of(se_tpg,
1859 struct scsiback_tpg, se_tpg);
1861 mutex_lock(&tpg->tv_tpg_mutex);
1862 tpg->tv_tpg_port_count++;
1863 mutex_unlock(&tpg->tv_tpg_mutex);
1868 static void scsiback_port_unlink(struct se_portal_group *se_tpg,
1871 struct scsiback_tpg *tpg = container_of(se_tpg,
1872 struct scsiback_tpg, se_tpg);
1874 mutex_lock(&tpg->tv_tpg_mutex);
1875 tpg->tv_tpg_port_count--;
1876 mutex_unlock(&tpg->tv_tpg_mutex);
1879 static struct se_portal_group *
1880 scsiback_make_tpg(struct se_wwn *wwn,
1881 struct config_group *group,
1884 struct scsiback_tport *tport = container_of(wwn,
1885 struct scsiback_tport, tport_wwn);
1887 struct scsiback_tpg *tpg;
1891 if (strstr(name, "tpgt_") != name)
1892 return ERR_PTR(-EINVAL);
1893 ret = kstrtou16(name + 5, 10, &tpgt);
1895 return ERR_PTR(ret);
1897 tpg = kzalloc(sizeof(struct scsiback_tpg), GFP_KERNEL);
1899 return ERR_PTR(-ENOMEM);
1901 mutex_init(&tpg->tv_tpg_mutex);
1902 INIT_LIST_HEAD(&tpg->tv_tpg_list);
1903 INIT_LIST_HEAD(&tpg->info_list);
1905 tpg->tport_tpgt = tpgt;
1907 ret = core_tpg_register(&scsiback_fabric_configfs->tf_ops, wwn,
1908 &tpg->se_tpg, tpg, TRANSPORT_TPG_TYPE_NORMAL);
1913 mutex_lock(&scsiback_mutex);
1914 list_add_tail(&tpg->tv_tpg_list, &scsiback_list);
1915 mutex_unlock(&scsiback_mutex);
1917 return &tpg->se_tpg;
1920 static void scsiback_drop_tpg(struct se_portal_group *se_tpg)
1922 struct scsiback_tpg *tpg = container_of(se_tpg,
1923 struct scsiback_tpg, se_tpg);
1925 mutex_lock(&scsiback_mutex);
1926 list_del(&tpg->tv_tpg_list);
1927 mutex_unlock(&scsiback_mutex);
1929 * Release the virtual I_T Nexus for this xen-pvscsi TPG
1931 scsiback_drop_nexus(tpg);
1933 * Deregister the se_tpg from TCM..
1935 core_tpg_deregister(se_tpg);
1939 static int scsiback_check_true(struct se_portal_group *se_tpg)
1944 static int scsiback_check_false(struct se_portal_group *se_tpg)
1949 static struct target_core_fabric_ops scsiback_ops = {
1950 .get_fabric_name = scsiback_get_fabric_name,
1951 .get_fabric_proto_ident = scsiback_get_fabric_proto_ident,
1952 .tpg_get_wwn = scsiback_get_fabric_wwn,
1953 .tpg_get_tag = scsiback_get_tag,
1954 .tpg_get_default_depth = scsiback_get_default_depth,
1955 .tpg_get_pr_transport_id = scsiback_get_pr_transport_id,
1956 .tpg_get_pr_transport_id_len = scsiback_get_pr_transport_id_len,
1957 .tpg_parse_pr_out_transport_id = scsiback_parse_pr_out_transport_id,
1958 .tpg_check_demo_mode = scsiback_check_true,
1959 .tpg_check_demo_mode_cache = scsiback_check_true,
1960 .tpg_check_demo_mode_write_protect = scsiback_check_false,
1961 .tpg_check_prod_mode_write_protect = scsiback_check_false,
1962 .tpg_alloc_fabric_acl = scsiback_alloc_fabric_acl,
1963 .tpg_release_fabric_acl = scsiback_release_fabric_acl,
1964 .tpg_get_inst_index = scsiback_tpg_get_inst_index,
1965 .check_stop_free = scsiback_check_stop_free,
1966 .release_cmd = scsiback_release_cmd,
1967 .put_session = NULL,
1968 .shutdown_session = scsiback_shutdown_session,
1969 .close_session = scsiback_close_session,
1970 .sess_get_index = scsiback_sess_get_index,
1971 .sess_get_initiator_sid = NULL,
1972 .write_pending = scsiback_write_pending,
1973 .write_pending_status = scsiback_write_pending_status,
1974 .set_default_node_attributes = scsiback_set_default_node_attrs,
1975 .get_task_tag = scsiback_get_task_tag,
1976 .get_cmd_state = scsiback_get_cmd_state,
1977 .queue_data_in = scsiback_queue_data_in,
1978 .queue_status = scsiback_queue_status,
1979 .queue_tm_rsp = scsiback_queue_tm_rsp,
1980 .aborted_task = scsiback_aborted_task,
1982 * Setup callers for generic logic in target_core_fabric_configfs.c
1984 .fabric_make_wwn = scsiback_make_tport,
1985 .fabric_drop_wwn = scsiback_drop_tport,
1986 .fabric_make_tpg = scsiback_make_tpg,
1987 .fabric_drop_tpg = scsiback_drop_tpg,
1988 .fabric_post_link = scsiback_port_link,
1989 .fabric_pre_unlink = scsiback_port_unlink,
1990 .fabric_make_np = NULL,
1991 .fabric_drop_np = NULL,
1993 .fabric_make_nodeacl = scsiback_make_nodeacl,
1994 .fabric_drop_nodeacl = scsiback_drop_nodeacl,
1998 static int scsiback_register_configfs(void)
2000 struct target_fabric_configfs *fabric;
2003 pr_debug("xen-pvscsi: fabric module %s on %s/%s on "UTS_RELEASE"\n",
2004 VSCSI_VERSION, utsname()->sysname, utsname()->machine);
2006 * Register the top level struct config_item_type with TCM core
2008 fabric = target_fabric_configfs_init(THIS_MODULE, "xen-pvscsi");
2010 return PTR_ERR(fabric);
2013 * Setup fabric->tf_ops from our local scsiback_ops
2015 fabric->tf_ops = scsiback_ops;
2017 * Setup default attribute lists for various fabric->tf_cit_tmpl
2019 fabric->tf_cit_tmpl.tfc_wwn_cit.ct_attrs = scsiback_wwn_attrs;
2020 fabric->tf_cit_tmpl.tfc_tpg_base_cit.ct_attrs = scsiback_tpg_attrs;
2021 fabric->tf_cit_tmpl.tfc_tpg_attrib_cit.ct_attrs = NULL;
2022 fabric->tf_cit_tmpl.tfc_tpg_param_cit.ct_attrs = scsiback_param_attrs;
2023 fabric->tf_cit_tmpl.tfc_tpg_np_base_cit.ct_attrs = NULL;
2024 fabric->tf_cit_tmpl.tfc_tpg_nacl_base_cit.ct_attrs = NULL;
2025 fabric->tf_cit_tmpl.tfc_tpg_nacl_attrib_cit.ct_attrs = NULL;
2026 fabric->tf_cit_tmpl.tfc_tpg_nacl_auth_cit.ct_attrs = NULL;
2027 fabric->tf_cit_tmpl.tfc_tpg_nacl_param_cit.ct_attrs = NULL;
2029 * Register the fabric for use within TCM
2031 ret = target_fabric_configfs_register(fabric);
2033 target_fabric_configfs_free(fabric);
2037 * Setup our local pointer to *fabric
2039 scsiback_fabric_configfs = fabric;
2040 pr_debug("xen-pvscsi: Set fabric -> scsiback_fabric_configfs\n");
2044 static void scsiback_deregister_configfs(void)
2046 if (!scsiback_fabric_configfs)
2049 target_fabric_configfs_deregister(scsiback_fabric_configfs);
2050 scsiback_fabric_configfs = NULL;
2051 pr_debug("xen-pvscsi: Cleared scsiback_fabric_configfs\n");
2054 static const struct xenbus_device_id scsiback_ids[] = {
2059 static struct xenbus_driver scsiback_driver = {
2060 .ids = scsiback_ids,
2061 .probe = scsiback_probe,
2062 .remove = scsiback_remove,
2063 .otherend_changed = scsiback_frontend_changed
2066 static void scsiback_init_pend(void *p)
2068 struct vscsibk_pend *pend = p;
2071 memset(pend, 0, sizeof(*pend));
2072 for (i = 0; i < VSCSI_MAX_GRANTS; i++)
2073 pend->grant_handles[i] = SCSIBACK_INVALID_HANDLE;
2076 static int __init scsiback_init(void)
2083 scsiback_cachep = kmem_cache_create("vscsiif_cache",
2084 sizeof(struct vscsibk_pend), 0, 0, scsiback_init_pend);
2085 if (!scsiback_cachep)
2088 ret = xenbus_register_backend(&scsiback_driver);
2090 goto out_cache_destroy;
2092 ret = scsiback_register_configfs();
2094 goto out_unregister_xenbus;
2098 out_unregister_xenbus:
2099 xenbus_unregister_driver(&scsiback_driver);
2101 kmem_cache_destroy(scsiback_cachep);
2102 pr_err("xen-pvscsi: %s: error %d\n", __func__, ret);
2106 static void __exit scsiback_exit(void)
2110 while (free_pages_num) {
2111 if (get_free_page(&page))
2113 free_xenballooned_pages(1, &page);
2115 scsiback_deregister_configfs();
2116 xenbus_unregister_driver(&scsiback_driver);
2117 kmem_cache_destroy(scsiback_cachep);
2120 module_init(scsiback_init);
2121 module_exit(scsiback_exit);
2123 MODULE_DESCRIPTION("Xen SCSI backend driver");
2124 MODULE_LICENSE("Dual BSD/GPL");
2125 MODULE_ALIAS("xen-backend:vscsi");
2126 MODULE_AUTHOR("Juergen Gross <jgross@suse.com>");