2 * Copyright (c) 2016 Avago Technologies. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of version 2 of the GNU General Public License as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful.
9 * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
10 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
11 * PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE DISCLAIMED, EXCEPT TO
12 * THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO BE LEGALLY INVALID.
13 * See the GNU General Public License for more details, a copy of which
14 * can be found in the file COPYING included with this package
17 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
18 #include <linux/module.h>
19 #include <linux/slab.h>
20 #include <linux/blk-mq.h>
21 #include <linux/parser.h>
22 #include <linux/random.h>
23 #include <uapi/scsi/fc/fc_fs.h>
24 #include <uapi/scsi/fc/fc_els.h>
27 #include <linux/nvme-fc-driver.h>
28 #include <linux/nvme-fc.h>
31 /* *************************** Data Structures/Defines ****************** */
34 #define NVMET_LS_CTX_COUNT 4
36 /* for this implementation, assume small single frame rqst/rsp */
37 #define NVME_FC_MAX_LS_BUFFER_SIZE 2048
39 struct nvmet_fc_tgtport;
40 struct nvmet_fc_tgt_assoc;
42 struct nvmet_fc_ls_iod {
43 struct nvmefc_tgt_ls_req *lsreq;
44 struct nvmefc_tgt_fcp_req *fcpreq; /* only if RS */
46 struct list_head ls_list; /* tgtport->ls_list */
48 struct nvmet_fc_tgtport *tgtport;
49 struct nvmet_fc_tgt_assoc *assoc;
56 struct scatterlist sg[2];
58 struct work_struct work;
59 } __aligned(sizeof(unsigned long long));
61 /* desired maximum for a single sequence - if sg list allows it */
62 #define NVMET_FC_MAX_SEQ_LENGTH (256 * 1024)
64 enum nvmet_fcp_datadir {
71 struct nvmet_fc_fcp_iod {
72 struct nvmefc_tgt_fcp_req *fcpreq;
74 struct nvme_fc_cmd_iu cmdiubuf;
75 struct nvme_fc_ersp_iu rspiubuf;
77 struct scatterlist *next_sg;
78 struct scatterlist *data_sg;
82 enum nvmet_fcp_datadir io_dir;
90 struct work_struct work;
91 struct work_struct done_work;
93 struct nvmet_fc_tgtport *tgtport;
94 struct nvmet_fc_tgt_queue *queue;
96 struct list_head fcp_list; /* tgtport->fcp_list */
99 struct nvmet_fc_tgtport {
101 struct nvmet_fc_target_port fc_target_port;
103 struct list_head tgt_list; /* nvmet_fc_target_list */
104 struct device *dev; /* dev for dma mapping */
105 struct nvmet_fc_target_template *ops;
107 struct nvmet_fc_ls_iod *iod;
109 struct list_head ls_list;
110 struct list_head ls_busylist;
111 struct list_head assoc_list;
112 struct ida assoc_cnt;
113 struct nvmet_port *port;
118 struct nvmet_fc_defer_fcp_req {
119 struct list_head req_list;
120 struct nvmefc_tgt_fcp_req *fcp_req;
123 struct nvmet_fc_tgt_queue {
135 struct nvmet_port *port;
136 struct nvmet_cq nvme_cq;
137 struct nvmet_sq nvme_sq;
138 struct nvmet_fc_tgt_assoc *assoc;
139 struct nvmet_fc_fcp_iod *fod; /* array of fcp_iods */
140 struct list_head fod_list;
141 struct list_head pending_cmd_list;
142 struct list_head avail_defer_list;
143 struct workqueue_struct *work_q;
145 } __aligned(sizeof(unsigned long long));
147 struct nvmet_fc_tgt_assoc {
150 struct nvmet_fc_tgtport *tgtport;
151 struct list_head a_list;
152 struct nvmet_fc_tgt_queue *queues[NVMET_NR_QUEUES + 1];
158 nvmet_fc_iodnum(struct nvmet_fc_ls_iod *iodptr)
160 return (iodptr - iodptr->tgtport->iod);
164 nvmet_fc_fodnum(struct nvmet_fc_fcp_iod *fodptr)
166 return (fodptr - fodptr->queue->fod);
171 * Association and Connection IDs:
173 * Association ID will have random number in upper 6 bytes and zero
176 * Connection IDs will be Association ID with QID or'd in lower 2 bytes
178 * note: Association ID = Connection ID for queue 0
180 #define BYTES_FOR_QID sizeof(u16)
181 #define BYTES_FOR_QID_SHIFT (BYTES_FOR_QID * 8)
182 #define NVMET_FC_QUEUEID_MASK ((u64)((1 << BYTES_FOR_QID_SHIFT) - 1))
185 nvmet_fc_makeconnid(struct nvmet_fc_tgt_assoc *assoc, u16 qid)
187 return (assoc->association_id | qid);
191 nvmet_fc_getassociationid(u64 connectionid)
193 return connectionid & ~NVMET_FC_QUEUEID_MASK;
197 nvmet_fc_getqueueid(u64 connectionid)
199 return (u16)(connectionid & NVMET_FC_QUEUEID_MASK);
202 static inline struct nvmet_fc_tgtport *
203 targetport_to_tgtport(struct nvmet_fc_target_port *targetport)
205 return container_of(targetport, struct nvmet_fc_tgtport,
209 static inline struct nvmet_fc_fcp_iod *
210 nvmet_req_to_fod(struct nvmet_req *nvme_req)
212 return container_of(nvme_req, struct nvmet_fc_fcp_iod, req);
216 /* *************************** Globals **************************** */
219 static DEFINE_SPINLOCK(nvmet_fc_tgtlock);
221 static LIST_HEAD(nvmet_fc_target_list);
222 static DEFINE_IDA(nvmet_fc_tgtport_cnt);
225 static void nvmet_fc_handle_ls_rqst_work(struct work_struct *work);
226 static void nvmet_fc_handle_fcp_rqst_work(struct work_struct *work);
227 static void nvmet_fc_fcp_rqst_op_done_work(struct work_struct *work);
228 static void nvmet_fc_tgt_a_put(struct nvmet_fc_tgt_assoc *assoc);
229 static int nvmet_fc_tgt_a_get(struct nvmet_fc_tgt_assoc *assoc);
230 static void nvmet_fc_tgt_q_put(struct nvmet_fc_tgt_queue *queue);
231 static int nvmet_fc_tgt_q_get(struct nvmet_fc_tgt_queue *queue);
232 static void nvmet_fc_tgtport_put(struct nvmet_fc_tgtport *tgtport);
233 static int nvmet_fc_tgtport_get(struct nvmet_fc_tgtport *tgtport);
234 static void nvmet_fc_handle_fcp_rqst(struct nvmet_fc_tgtport *tgtport,
235 struct nvmet_fc_fcp_iod *fod);
238 /* *********************** FC-NVME DMA Handling **************************** */
241 * The fcloop device passes in a NULL device pointer. Real LLD's will
242 * pass in a valid device pointer. If NULL is passed to the dma mapping
243 * routines, depending on the platform, it may or may not succeed, and
247 * Wrapper all the dma routines and check the dev pointer.
249 * If simple mappings (return just a dma address, we'll noop them,
250 * returning a dma address of 0.
252 * On more complex mappings (dma_map_sg), a pseudo routine fills
253 * in the scatter list, setting all dma addresses to 0.
256 static inline dma_addr_t
257 fc_dma_map_single(struct device *dev, void *ptr, size_t size,
258 enum dma_data_direction dir)
260 return dev ? dma_map_single(dev, ptr, size, dir) : (dma_addr_t)0L;
264 fc_dma_mapping_error(struct device *dev, dma_addr_t dma_addr)
266 return dev ? dma_mapping_error(dev, dma_addr) : 0;
270 fc_dma_unmap_single(struct device *dev, dma_addr_t addr, size_t size,
271 enum dma_data_direction dir)
274 dma_unmap_single(dev, addr, size, dir);
278 fc_dma_sync_single_for_cpu(struct device *dev, dma_addr_t addr, size_t size,
279 enum dma_data_direction dir)
282 dma_sync_single_for_cpu(dev, addr, size, dir);
286 fc_dma_sync_single_for_device(struct device *dev, dma_addr_t addr, size_t size,
287 enum dma_data_direction dir)
290 dma_sync_single_for_device(dev, addr, size, dir);
293 /* pseudo dma_map_sg call */
295 fc_map_sg(struct scatterlist *sg, int nents)
297 struct scatterlist *s;
300 WARN_ON(nents == 0 || sg[0].length == 0);
302 for_each_sg(sg, s, nents, i) {
304 #ifdef CONFIG_NEED_SG_DMA_LENGTH
305 s->dma_length = s->length;
312 fc_dma_map_sg(struct device *dev, struct scatterlist *sg, int nents,
313 enum dma_data_direction dir)
315 return dev ? dma_map_sg(dev, sg, nents, dir) : fc_map_sg(sg, nents);
319 fc_dma_unmap_sg(struct device *dev, struct scatterlist *sg, int nents,
320 enum dma_data_direction dir)
323 dma_unmap_sg(dev, sg, nents, dir);
327 /* *********************** FC-NVME Port Management ************************ */
331 nvmet_fc_alloc_ls_iodlist(struct nvmet_fc_tgtport *tgtport)
333 struct nvmet_fc_ls_iod *iod;
336 iod = kcalloc(NVMET_LS_CTX_COUNT, sizeof(struct nvmet_fc_ls_iod),
343 for (i = 0; i < NVMET_LS_CTX_COUNT; iod++, i++) {
344 INIT_WORK(&iod->work, nvmet_fc_handle_ls_rqst_work);
345 iod->tgtport = tgtport;
346 list_add_tail(&iod->ls_list, &tgtport->ls_list);
348 iod->rqstbuf = kcalloc(2, NVME_FC_MAX_LS_BUFFER_SIZE,
353 iod->rspbuf = iod->rqstbuf + NVME_FC_MAX_LS_BUFFER_SIZE;
355 iod->rspdma = fc_dma_map_single(tgtport->dev, iod->rspbuf,
356 NVME_FC_MAX_LS_BUFFER_SIZE,
358 if (fc_dma_mapping_error(tgtport->dev, iod->rspdma))
366 list_del(&iod->ls_list);
367 for (iod--, i--; i >= 0; iod--, i--) {
368 fc_dma_unmap_single(tgtport->dev, iod->rspdma,
369 NVME_FC_MAX_LS_BUFFER_SIZE, DMA_TO_DEVICE);
371 list_del(&iod->ls_list);
380 nvmet_fc_free_ls_iodlist(struct nvmet_fc_tgtport *tgtport)
382 struct nvmet_fc_ls_iod *iod = tgtport->iod;
385 for (i = 0; i < NVMET_LS_CTX_COUNT; iod++, i++) {
386 fc_dma_unmap_single(tgtport->dev,
387 iod->rspdma, NVME_FC_MAX_LS_BUFFER_SIZE,
390 list_del(&iod->ls_list);
395 static struct nvmet_fc_ls_iod *
396 nvmet_fc_alloc_ls_iod(struct nvmet_fc_tgtport *tgtport)
398 struct nvmet_fc_ls_iod *iod;
401 spin_lock_irqsave(&tgtport->lock, flags);
402 iod = list_first_entry_or_null(&tgtport->ls_list,
403 struct nvmet_fc_ls_iod, ls_list);
405 list_move_tail(&iod->ls_list, &tgtport->ls_busylist);
406 spin_unlock_irqrestore(&tgtport->lock, flags);
412 nvmet_fc_free_ls_iod(struct nvmet_fc_tgtport *tgtport,
413 struct nvmet_fc_ls_iod *iod)
417 spin_lock_irqsave(&tgtport->lock, flags);
418 list_move(&iod->ls_list, &tgtport->ls_list);
419 spin_unlock_irqrestore(&tgtport->lock, flags);
423 nvmet_fc_prep_fcp_iodlist(struct nvmet_fc_tgtport *tgtport,
424 struct nvmet_fc_tgt_queue *queue)
426 struct nvmet_fc_fcp_iod *fod = queue->fod;
429 for (i = 0; i < queue->sqsize; fod++, i++) {
430 INIT_WORK(&fod->work, nvmet_fc_handle_fcp_rqst_work);
431 INIT_WORK(&fod->done_work, nvmet_fc_fcp_rqst_op_done_work);
432 fod->tgtport = tgtport;
436 fod->aborted = false;
438 list_add_tail(&fod->fcp_list, &queue->fod_list);
439 spin_lock_init(&fod->flock);
441 fod->rspdma = fc_dma_map_single(tgtport->dev, &fod->rspiubuf,
442 sizeof(fod->rspiubuf), DMA_TO_DEVICE);
443 if (fc_dma_mapping_error(tgtport->dev, fod->rspdma)) {
444 list_del(&fod->fcp_list);
445 for (fod--, i--; i >= 0; fod--, i--) {
446 fc_dma_unmap_single(tgtport->dev, fod->rspdma,
447 sizeof(fod->rspiubuf),
450 list_del(&fod->fcp_list);
459 nvmet_fc_destroy_fcp_iodlist(struct nvmet_fc_tgtport *tgtport,
460 struct nvmet_fc_tgt_queue *queue)
462 struct nvmet_fc_fcp_iod *fod = queue->fod;
465 for (i = 0; i < queue->sqsize; fod++, i++) {
467 fc_dma_unmap_single(tgtport->dev, fod->rspdma,
468 sizeof(fod->rspiubuf), DMA_TO_DEVICE);
472 static struct nvmet_fc_fcp_iod *
473 nvmet_fc_alloc_fcp_iod(struct nvmet_fc_tgt_queue *queue)
475 struct nvmet_fc_fcp_iod *fod;
477 lockdep_assert_held(&queue->qlock);
479 fod = list_first_entry_or_null(&queue->fod_list,
480 struct nvmet_fc_fcp_iod, fcp_list);
482 list_del(&fod->fcp_list);
485 * no queue reference is taken, as it was taken by the
486 * queue lookup just prior to the allocation. The iod
487 * will "inherit" that reference.
495 nvmet_fc_queue_fcp_req(struct nvmet_fc_tgtport *tgtport,
496 struct nvmet_fc_tgt_queue *queue,
497 struct nvmefc_tgt_fcp_req *fcpreq)
499 struct nvmet_fc_fcp_iod *fod = fcpreq->nvmet_fc_private;
502 * put all admin cmds on hw queue id 0. All io commands go to
503 * the respective hw queue based on a modulo basis
505 fcpreq->hwqid = queue->qid ?
506 ((queue->qid - 1) % tgtport->ops->max_hw_queues) : 0;
508 if (tgtport->ops->target_features & NVMET_FCTGTFEAT_CMD_IN_ISR)
509 queue_work_on(queue->cpu, queue->work_q, &fod->work);
511 nvmet_fc_handle_fcp_rqst(tgtport, fod);
515 nvmet_fc_free_fcp_iod(struct nvmet_fc_tgt_queue *queue,
516 struct nvmet_fc_fcp_iod *fod)
518 struct nvmefc_tgt_fcp_req *fcpreq = fod->fcpreq;
519 struct nvmet_fc_tgtport *tgtport = fod->tgtport;
520 struct nvmet_fc_defer_fcp_req *deferfcp;
523 fc_dma_sync_single_for_cpu(tgtport->dev, fod->rspdma,
524 sizeof(fod->rspiubuf), DMA_TO_DEVICE);
526 fcpreq->nvmet_fc_private = NULL;
530 fod->aborted = false;
531 fod->writedataactive = false;
534 tgtport->ops->fcp_req_release(&tgtport->fc_target_port, fcpreq);
536 /* release the queue lookup reference on the completed IO */
537 nvmet_fc_tgt_q_put(queue);
539 spin_lock_irqsave(&queue->qlock, flags);
540 deferfcp = list_first_entry_or_null(&queue->pending_cmd_list,
541 struct nvmet_fc_defer_fcp_req, req_list);
543 list_add_tail(&fod->fcp_list, &fod->queue->fod_list);
544 spin_unlock_irqrestore(&queue->qlock, flags);
548 /* Re-use the fod for the next pending cmd that was deferred */
549 list_del(&deferfcp->req_list);
551 fcpreq = deferfcp->fcp_req;
553 /* deferfcp can be reused for another IO at a later date */
554 list_add_tail(&deferfcp->req_list, &queue->avail_defer_list);
556 spin_unlock_irqrestore(&queue->qlock, flags);
558 /* Save NVME CMD IO in fod */
559 memcpy(&fod->cmdiubuf, fcpreq->rspaddr, fcpreq->rsplen);
561 /* Setup new fcpreq to be processed */
562 fcpreq->rspaddr = NULL;
564 fcpreq->nvmet_fc_private = fod;
565 fod->fcpreq = fcpreq;
568 /* inform LLDD IO is now being processed */
569 tgtport->ops->defer_rcv(&tgtport->fc_target_port, fcpreq);
571 /* Submit deferred IO for processing */
572 nvmet_fc_queue_fcp_req(tgtport, queue, fcpreq);
575 * Leave the queue lookup get reference taken when
576 * fod was originally allocated.
581 nvmet_fc_queue_to_cpu(struct nvmet_fc_tgtport *tgtport, int qid)
585 if (tgtport->ops->max_hw_queues == 1)
586 return WORK_CPU_UNBOUND;
588 /* Simple cpu selection based on qid modulo active cpu count */
589 idx = !qid ? 0 : (qid - 1) % num_active_cpus();
591 /* find the n'th active cpu */
592 for (cpu = 0, cnt = 0; ; ) {
593 if (cpu_active(cpu)) {
598 cpu = (cpu + 1) % num_possible_cpus();
604 static struct nvmet_fc_tgt_queue *
605 nvmet_fc_alloc_target_queue(struct nvmet_fc_tgt_assoc *assoc,
608 struct nvmet_fc_tgt_queue *queue;
612 if (qid > NVMET_NR_QUEUES)
615 queue = kzalloc((sizeof(*queue) +
616 (sizeof(struct nvmet_fc_fcp_iod) * sqsize)),
621 if (!nvmet_fc_tgt_a_get(assoc))
624 queue->work_q = alloc_workqueue("ntfc%d.%d.%d", 0, 0,
625 assoc->tgtport->fc_target_port.port_num,
630 queue->fod = (struct nvmet_fc_fcp_iod *)&queue[1];
632 queue->sqsize = sqsize;
633 queue->assoc = assoc;
634 queue->port = assoc->tgtport->port;
635 queue->cpu = nvmet_fc_queue_to_cpu(assoc->tgtport, qid);
636 INIT_LIST_HEAD(&queue->fod_list);
637 INIT_LIST_HEAD(&queue->avail_defer_list);
638 INIT_LIST_HEAD(&queue->pending_cmd_list);
639 atomic_set(&queue->connected, 0);
640 atomic_set(&queue->sqtail, 0);
641 atomic_set(&queue->rsn, 1);
642 atomic_set(&queue->zrspcnt, 0);
643 spin_lock_init(&queue->qlock);
644 kref_init(&queue->ref);
646 nvmet_fc_prep_fcp_iodlist(assoc->tgtport, queue);
648 ret = nvmet_sq_init(&queue->nvme_sq);
650 goto out_fail_iodlist;
652 WARN_ON(assoc->queues[qid]);
653 spin_lock_irqsave(&assoc->tgtport->lock, flags);
654 assoc->queues[qid] = queue;
655 spin_unlock_irqrestore(&assoc->tgtport->lock, flags);
660 nvmet_fc_destroy_fcp_iodlist(assoc->tgtport, queue);
661 destroy_workqueue(queue->work_q);
663 nvmet_fc_tgt_a_put(assoc);
671 nvmet_fc_tgt_queue_free(struct kref *ref)
673 struct nvmet_fc_tgt_queue *queue =
674 container_of(ref, struct nvmet_fc_tgt_queue, ref);
677 spin_lock_irqsave(&queue->assoc->tgtport->lock, flags);
678 queue->assoc->queues[queue->qid] = NULL;
679 spin_unlock_irqrestore(&queue->assoc->tgtport->lock, flags);
681 nvmet_fc_destroy_fcp_iodlist(queue->assoc->tgtport, queue);
683 nvmet_fc_tgt_a_put(queue->assoc);
685 destroy_workqueue(queue->work_q);
691 nvmet_fc_tgt_q_put(struct nvmet_fc_tgt_queue *queue)
693 kref_put(&queue->ref, nvmet_fc_tgt_queue_free);
697 nvmet_fc_tgt_q_get(struct nvmet_fc_tgt_queue *queue)
699 return kref_get_unless_zero(&queue->ref);
704 nvmet_fc_delete_target_queue(struct nvmet_fc_tgt_queue *queue)
706 struct nvmet_fc_tgtport *tgtport = queue->assoc->tgtport;
707 struct nvmet_fc_fcp_iod *fod = queue->fod;
708 struct nvmet_fc_defer_fcp_req *deferfcp, *tempptr;
710 int i, writedataactive;
713 disconnect = atomic_xchg(&queue->connected, 0);
715 spin_lock_irqsave(&queue->qlock, flags);
716 /* about outstanding io's */
717 for (i = 0; i < queue->sqsize; fod++, i++) {
719 spin_lock(&fod->flock);
721 writedataactive = fod->writedataactive;
722 spin_unlock(&fod->flock);
724 * only call lldd abort routine if waiting for
725 * writedata. other outstanding ops should finish
728 if (writedataactive) {
729 spin_lock(&fod->flock);
731 spin_unlock(&fod->flock);
732 tgtport->ops->fcp_abort(
733 &tgtport->fc_target_port, fod->fcpreq);
738 /* Cleanup defer'ed IOs in queue */
739 list_for_each_entry_safe(deferfcp, tempptr, &queue->avail_defer_list,
741 list_del(&deferfcp->req_list);
746 deferfcp = list_first_entry_or_null(&queue->pending_cmd_list,
747 struct nvmet_fc_defer_fcp_req, req_list);
751 list_del(&deferfcp->req_list);
752 spin_unlock_irqrestore(&queue->qlock, flags);
754 tgtport->ops->defer_rcv(&tgtport->fc_target_port,
757 tgtport->ops->fcp_abort(&tgtport->fc_target_port,
760 tgtport->ops->fcp_req_release(&tgtport->fc_target_port,
763 /* release the queue lookup reference */
764 nvmet_fc_tgt_q_put(queue);
768 spin_lock_irqsave(&queue->qlock, flags);
770 spin_unlock_irqrestore(&queue->qlock, flags);
772 flush_workqueue(queue->work_q);
775 nvmet_sq_destroy(&queue->nvme_sq);
777 nvmet_fc_tgt_q_put(queue);
780 static struct nvmet_fc_tgt_queue *
781 nvmet_fc_find_target_queue(struct nvmet_fc_tgtport *tgtport,
784 struct nvmet_fc_tgt_assoc *assoc;
785 struct nvmet_fc_tgt_queue *queue;
786 u64 association_id = nvmet_fc_getassociationid(connection_id);
787 u16 qid = nvmet_fc_getqueueid(connection_id);
790 if (qid > NVMET_NR_QUEUES)
793 spin_lock_irqsave(&tgtport->lock, flags);
794 list_for_each_entry(assoc, &tgtport->assoc_list, a_list) {
795 if (association_id == assoc->association_id) {
796 queue = assoc->queues[qid];
798 (!atomic_read(&queue->connected) ||
799 !nvmet_fc_tgt_q_get(queue)))
801 spin_unlock_irqrestore(&tgtport->lock, flags);
805 spin_unlock_irqrestore(&tgtport->lock, flags);
809 static struct nvmet_fc_tgt_assoc *
810 nvmet_fc_alloc_target_assoc(struct nvmet_fc_tgtport *tgtport)
812 struct nvmet_fc_tgt_assoc *assoc, *tmpassoc;
816 bool needrandom = true;
818 assoc = kzalloc(sizeof(*assoc), GFP_KERNEL);
822 idx = ida_simple_get(&tgtport->assoc_cnt, 0, 0, GFP_KERNEL);
826 if (!nvmet_fc_tgtport_get(tgtport))
829 assoc->tgtport = tgtport;
831 INIT_LIST_HEAD(&assoc->a_list);
832 kref_init(&assoc->ref);
835 get_random_bytes(&ran, sizeof(ran) - BYTES_FOR_QID);
836 ran = ran << BYTES_FOR_QID_SHIFT;
838 spin_lock_irqsave(&tgtport->lock, flags);
840 list_for_each_entry(tmpassoc, &tgtport->assoc_list, a_list)
841 if (ran == tmpassoc->association_id) {
846 assoc->association_id = ran;
847 list_add_tail(&assoc->a_list, &tgtport->assoc_list);
849 spin_unlock_irqrestore(&tgtport->lock, flags);
855 ida_simple_remove(&tgtport->assoc_cnt, idx);
862 nvmet_fc_target_assoc_free(struct kref *ref)
864 struct nvmet_fc_tgt_assoc *assoc =
865 container_of(ref, struct nvmet_fc_tgt_assoc, ref);
866 struct nvmet_fc_tgtport *tgtport = assoc->tgtport;
869 spin_lock_irqsave(&tgtport->lock, flags);
870 list_del(&assoc->a_list);
871 spin_unlock_irqrestore(&tgtport->lock, flags);
872 ida_simple_remove(&tgtport->assoc_cnt, assoc->a_id);
874 nvmet_fc_tgtport_put(tgtport);
878 nvmet_fc_tgt_a_put(struct nvmet_fc_tgt_assoc *assoc)
880 kref_put(&assoc->ref, nvmet_fc_target_assoc_free);
884 nvmet_fc_tgt_a_get(struct nvmet_fc_tgt_assoc *assoc)
886 return kref_get_unless_zero(&assoc->ref);
890 nvmet_fc_delete_target_assoc(struct nvmet_fc_tgt_assoc *assoc)
892 struct nvmet_fc_tgtport *tgtport = assoc->tgtport;
893 struct nvmet_fc_tgt_queue *queue;
897 spin_lock_irqsave(&tgtport->lock, flags);
898 for (i = NVMET_NR_QUEUES; i >= 0; i--) {
899 queue = assoc->queues[i];
901 if (!nvmet_fc_tgt_q_get(queue))
903 spin_unlock_irqrestore(&tgtport->lock, flags);
904 nvmet_fc_delete_target_queue(queue);
905 nvmet_fc_tgt_q_put(queue);
906 spin_lock_irqsave(&tgtport->lock, flags);
909 spin_unlock_irqrestore(&tgtport->lock, flags);
911 nvmet_fc_tgt_a_put(assoc);
914 static struct nvmet_fc_tgt_assoc *
915 nvmet_fc_find_target_assoc(struct nvmet_fc_tgtport *tgtport,
918 struct nvmet_fc_tgt_assoc *assoc;
919 struct nvmet_fc_tgt_assoc *ret = NULL;
922 spin_lock_irqsave(&tgtport->lock, flags);
923 list_for_each_entry(assoc, &tgtport->assoc_list, a_list) {
924 if (association_id == assoc->association_id) {
926 nvmet_fc_tgt_a_get(assoc);
930 spin_unlock_irqrestore(&tgtport->lock, flags);
937 * nvme_fc_register_targetport - transport entry point called by an
938 * LLDD to register the existence of a local
939 * NVME subystem FC port.
940 * @pinfo: pointer to information about the port to be registered
941 * @template: LLDD entrypoints and operational parameters for the port
942 * @dev: physical hardware device node port corresponds to. Will be
943 * used for DMA mappings
944 * @portptr: pointer to a local port pointer. Upon success, the routine
945 * will allocate a nvme_fc_local_port structure and place its
946 * address in the local port pointer. Upon failure, local port
947 * pointer will be set to NULL.
950 * a completion status. Must be 0 upon success; a negative errno
951 * (ex: -ENXIO) upon failure.
954 nvmet_fc_register_targetport(struct nvmet_fc_port_info *pinfo,
955 struct nvmet_fc_target_template *template,
957 struct nvmet_fc_target_port **portptr)
959 struct nvmet_fc_tgtport *newrec;
963 if (!template->xmt_ls_rsp || !template->fcp_op ||
964 !template->fcp_abort ||
965 !template->fcp_req_release || !template->targetport_delete ||
966 !template->max_hw_queues || !template->max_sgl_segments ||
967 !template->max_dif_sgl_segments || !template->dma_boundary) {
969 goto out_regtgt_failed;
972 newrec = kzalloc((sizeof(*newrec) + template->target_priv_sz),
976 goto out_regtgt_failed;
979 idx = ida_simple_get(&nvmet_fc_tgtport_cnt, 0, 0, GFP_KERNEL);
985 if (!get_device(dev) && dev) {
990 newrec->fc_target_port.node_name = pinfo->node_name;
991 newrec->fc_target_port.port_name = pinfo->port_name;
992 newrec->fc_target_port.private = &newrec[1];
993 newrec->fc_target_port.port_id = pinfo->port_id;
994 newrec->fc_target_port.port_num = idx;
995 INIT_LIST_HEAD(&newrec->tgt_list);
997 newrec->ops = template;
998 spin_lock_init(&newrec->lock);
999 INIT_LIST_HEAD(&newrec->ls_list);
1000 INIT_LIST_HEAD(&newrec->ls_busylist);
1001 INIT_LIST_HEAD(&newrec->assoc_list);
1002 kref_init(&newrec->ref);
1003 ida_init(&newrec->assoc_cnt);
1004 newrec->max_sg_cnt = template->max_sgl_segments;
1006 ret = nvmet_fc_alloc_ls_iodlist(newrec);
1009 goto out_free_newrec;
1012 spin_lock_irqsave(&nvmet_fc_tgtlock, flags);
1013 list_add_tail(&newrec->tgt_list, &nvmet_fc_target_list);
1014 spin_unlock_irqrestore(&nvmet_fc_tgtlock, flags);
1016 *portptr = &newrec->fc_target_port;
1022 ida_simple_remove(&nvmet_fc_tgtport_cnt, idx);
1029 EXPORT_SYMBOL_GPL(nvmet_fc_register_targetport);
1033 nvmet_fc_free_tgtport(struct kref *ref)
1035 struct nvmet_fc_tgtport *tgtport =
1036 container_of(ref, struct nvmet_fc_tgtport, ref);
1037 struct device *dev = tgtport->dev;
1038 unsigned long flags;
1040 spin_lock_irqsave(&nvmet_fc_tgtlock, flags);
1041 list_del(&tgtport->tgt_list);
1042 spin_unlock_irqrestore(&nvmet_fc_tgtlock, flags);
1044 nvmet_fc_free_ls_iodlist(tgtport);
1046 /* let the LLDD know we've finished tearing it down */
1047 tgtport->ops->targetport_delete(&tgtport->fc_target_port);
1049 ida_simple_remove(&nvmet_fc_tgtport_cnt,
1050 tgtport->fc_target_port.port_num);
1052 ida_destroy(&tgtport->assoc_cnt);
1060 nvmet_fc_tgtport_put(struct nvmet_fc_tgtport *tgtport)
1062 kref_put(&tgtport->ref, nvmet_fc_free_tgtport);
1066 nvmet_fc_tgtport_get(struct nvmet_fc_tgtport *tgtport)
1068 return kref_get_unless_zero(&tgtport->ref);
1072 __nvmet_fc_free_assocs(struct nvmet_fc_tgtport *tgtport)
1074 struct nvmet_fc_tgt_assoc *assoc, *next;
1075 unsigned long flags;
1077 spin_lock_irqsave(&tgtport->lock, flags);
1078 list_for_each_entry_safe(assoc, next,
1079 &tgtport->assoc_list, a_list) {
1080 if (!nvmet_fc_tgt_a_get(assoc))
1082 spin_unlock_irqrestore(&tgtport->lock, flags);
1083 nvmet_fc_delete_target_assoc(assoc);
1084 nvmet_fc_tgt_a_put(assoc);
1085 spin_lock_irqsave(&tgtport->lock, flags);
1087 spin_unlock_irqrestore(&tgtport->lock, flags);
1091 * nvmet layer has called to terminate an association
1094 nvmet_fc_delete_ctrl(struct nvmet_ctrl *ctrl)
1096 struct nvmet_fc_tgtport *tgtport, *next;
1097 struct nvmet_fc_tgt_assoc *assoc;
1098 struct nvmet_fc_tgt_queue *queue;
1099 unsigned long flags;
1100 bool found_ctrl = false;
1102 /* this is a bit ugly, but don't want to make locks layered */
1103 spin_lock_irqsave(&nvmet_fc_tgtlock, flags);
1104 list_for_each_entry_safe(tgtport, next, &nvmet_fc_target_list,
1106 if (!nvmet_fc_tgtport_get(tgtport))
1108 spin_unlock_irqrestore(&nvmet_fc_tgtlock, flags);
1110 spin_lock_irqsave(&tgtport->lock, flags);
1111 list_for_each_entry(assoc, &tgtport->assoc_list, a_list) {
1112 queue = assoc->queues[0];
1113 if (queue && queue->nvme_sq.ctrl == ctrl) {
1114 if (nvmet_fc_tgt_a_get(assoc))
1119 spin_unlock_irqrestore(&tgtport->lock, flags);
1121 nvmet_fc_tgtport_put(tgtport);
1124 nvmet_fc_delete_target_assoc(assoc);
1125 nvmet_fc_tgt_a_put(assoc);
1129 spin_lock_irqsave(&nvmet_fc_tgtlock, flags);
1131 spin_unlock_irqrestore(&nvmet_fc_tgtlock, flags);
1135 * nvme_fc_unregister_targetport - transport entry point called by an
1136 * LLDD to deregister/remove a previously
1137 * registered a local NVME subsystem FC port.
1138 * @tgtport: pointer to the (registered) target port that is to be
1142 * a completion status. Must be 0 upon success; a negative errno
1143 * (ex: -ENXIO) upon failure.
1146 nvmet_fc_unregister_targetport(struct nvmet_fc_target_port *target_port)
1148 struct nvmet_fc_tgtport *tgtport = targetport_to_tgtport(target_port);
1150 /* terminate any outstanding associations */
1151 __nvmet_fc_free_assocs(tgtport);
1153 nvmet_fc_tgtport_put(tgtport);
1157 EXPORT_SYMBOL_GPL(nvmet_fc_unregister_targetport);
1160 /* *********************** FC-NVME LS Handling **************************** */
1164 nvmet_fc_format_rsp_hdr(void *buf, u8 ls_cmd, __be32 desc_len, u8 rqst_ls_cmd)
1166 struct fcnvme_ls_acc_hdr *acc = buf;
1168 acc->w0.ls_cmd = ls_cmd;
1169 acc->desc_list_len = desc_len;
1170 acc->rqst.desc_tag = cpu_to_be32(FCNVME_LSDESC_RQST);
1171 acc->rqst.desc_len =
1172 fcnvme_lsdesc_len(sizeof(struct fcnvme_lsdesc_rqst));
1173 acc->rqst.w0.ls_cmd = rqst_ls_cmd;
1177 nvmet_fc_format_rjt(void *buf, u16 buflen, u8 ls_cmd,
1178 u8 reason, u8 explanation, u8 vendor)
1180 struct fcnvme_ls_rjt *rjt = buf;
1182 nvmet_fc_format_rsp_hdr(buf, FCNVME_LSDESC_RQST,
1183 fcnvme_lsdesc_len(sizeof(struct fcnvme_ls_rjt)),
1185 rjt->rjt.desc_tag = cpu_to_be32(FCNVME_LSDESC_RJT);
1186 rjt->rjt.desc_len = fcnvme_lsdesc_len(sizeof(struct fcnvme_lsdesc_rjt));
1187 rjt->rjt.reason_code = reason;
1188 rjt->rjt.reason_explanation = explanation;
1189 rjt->rjt.vendor = vendor;
1191 return sizeof(struct fcnvme_ls_rjt);
1194 /* Validation Error indexes into the string table below */
1197 VERR_CR_ASSOC_LEN = 1,
1198 VERR_CR_ASSOC_RQST_LEN = 2,
1199 VERR_CR_ASSOC_CMD = 3,
1200 VERR_CR_ASSOC_CMD_LEN = 4,
1201 VERR_ERSP_RATIO = 5,
1202 VERR_ASSOC_ALLOC_FAIL = 6,
1203 VERR_QUEUE_ALLOC_FAIL = 7,
1204 VERR_CR_CONN_LEN = 8,
1205 VERR_CR_CONN_RQST_LEN = 9,
1207 VERR_ASSOC_ID_LEN = 11,
1210 VERR_CONN_ID_LEN = 14,
1212 VERR_CR_CONN_CMD = 16,
1213 VERR_CR_CONN_CMD_LEN = 17,
1214 VERR_DISCONN_LEN = 18,
1215 VERR_DISCONN_RQST_LEN = 19,
1216 VERR_DISCONN_CMD = 20,
1217 VERR_DISCONN_CMD_LEN = 21,
1218 VERR_DISCONN_SCOPE = 22,
1220 VERR_RS_RQST_LEN = 24,
1222 VERR_RS_CMD_LEN = 26,
1227 static char *validation_errors[] = {
1229 "Bad CR_ASSOC Length",
1230 "Bad CR_ASSOC Rqst Length",
1232 "Bad CR_ASSOC Cmd Length",
1234 "Association Allocation Failed",
1235 "Queue Allocation Failed",
1236 "Bad CR_CONN Length",
1237 "Bad CR_CONN Rqst Length",
1238 "Not Association ID",
1239 "Bad Association ID Length",
1241 "Not Connection ID",
1242 "Bad Connection ID Length",
1245 "Bad CR_CONN Cmd Length",
1246 "Bad DISCONN Length",
1247 "Bad DISCONN Rqst Length",
1249 "Bad DISCONN Cmd Length",
1250 "Bad Disconnect Scope",
1252 "Bad RS Rqst Length",
1254 "Bad RS Cmd Length",
1256 "Bad RS Relative Offset",
1260 nvmet_fc_ls_create_association(struct nvmet_fc_tgtport *tgtport,
1261 struct nvmet_fc_ls_iod *iod)
1263 struct fcnvme_ls_cr_assoc_rqst *rqst =
1264 (struct fcnvme_ls_cr_assoc_rqst *)iod->rqstbuf;
1265 struct fcnvme_ls_cr_assoc_acc *acc =
1266 (struct fcnvme_ls_cr_assoc_acc *)iod->rspbuf;
1267 struct nvmet_fc_tgt_queue *queue;
1270 memset(acc, 0, sizeof(*acc));
1273 * FC-NVME spec changes. There are initiators sending different
1274 * lengths as padding sizes for Create Association Cmd descriptor
1276 * Accept anything of "minimum" length. Assume format per 1.15
1277 * spec (with HOSTID reduced to 16 bytes), ignore how long the
1278 * trailing pad length is.
1280 if (iod->rqstdatalen < FCNVME_LSDESC_CRA_RQST_MINLEN)
1281 ret = VERR_CR_ASSOC_LEN;
1282 else if (be32_to_cpu(rqst->desc_list_len) <
1283 FCNVME_LSDESC_CRA_RQST_MIN_LISTLEN)
1284 ret = VERR_CR_ASSOC_RQST_LEN;
1285 else if (rqst->assoc_cmd.desc_tag !=
1286 cpu_to_be32(FCNVME_LSDESC_CREATE_ASSOC_CMD))
1287 ret = VERR_CR_ASSOC_CMD;
1288 else if (be32_to_cpu(rqst->assoc_cmd.desc_len) <
1289 FCNVME_LSDESC_CRA_CMD_DESC_MIN_DESCLEN)
1290 ret = VERR_CR_ASSOC_CMD_LEN;
1291 else if (!rqst->assoc_cmd.ersp_ratio ||
1292 (be16_to_cpu(rqst->assoc_cmd.ersp_ratio) >=
1293 be16_to_cpu(rqst->assoc_cmd.sqsize)))
1294 ret = VERR_ERSP_RATIO;
1297 /* new association w/ admin queue */
1298 iod->assoc = nvmet_fc_alloc_target_assoc(tgtport);
1300 ret = VERR_ASSOC_ALLOC_FAIL;
1302 queue = nvmet_fc_alloc_target_queue(iod->assoc, 0,
1303 be16_to_cpu(rqst->assoc_cmd.sqsize));
1305 ret = VERR_QUEUE_ALLOC_FAIL;
1306 nvmet_fc_tgt_a_put(iod->assoc);
1312 dev_err(tgtport->dev,
1313 "Create Association LS failed: %s\n",
1314 validation_errors[ret]);
1315 iod->lsreq->rsplen = nvmet_fc_format_rjt(acc,
1316 NVME_FC_MAX_LS_BUFFER_SIZE, rqst->w0.ls_cmd,
1317 FCNVME_RJT_RC_LOGIC,
1318 FCNVME_RJT_EXP_NONE, 0);
1322 queue->ersp_ratio = be16_to_cpu(rqst->assoc_cmd.ersp_ratio);
1323 atomic_set(&queue->connected, 1);
1324 queue->sqhd = 0; /* best place to init value */
1326 /* format a response */
1328 iod->lsreq->rsplen = sizeof(*acc);
1330 nvmet_fc_format_rsp_hdr(acc, FCNVME_LS_ACC,
1332 sizeof(struct fcnvme_ls_cr_assoc_acc)),
1333 FCNVME_LS_CREATE_ASSOCIATION);
1334 acc->associd.desc_tag = cpu_to_be32(FCNVME_LSDESC_ASSOC_ID);
1335 acc->associd.desc_len =
1337 sizeof(struct fcnvme_lsdesc_assoc_id));
1338 acc->associd.association_id =
1339 cpu_to_be64(nvmet_fc_makeconnid(iod->assoc, 0));
1340 acc->connectid.desc_tag = cpu_to_be32(FCNVME_LSDESC_CONN_ID);
1341 acc->connectid.desc_len =
1343 sizeof(struct fcnvme_lsdesc_conn_id));
1344 acc->connectid.connection_id = acc->associd.association_id;
1348 nvmet_fc_ls_create_connection(struct nvmet_fc_tgtport *tgtport,
1349 struct nvmet_fc_ls_iod *iod)
1351 struct fcnvme_ls_cr_conn_rqst *rqst =
1352 (struct fcnvme_ls_cr_conn_rqst *)iod->rqstbuf;
1353 struct fcnvme_ls_cr_conn_acc *acc =
1354 (struct fcnvme_ls_cr_conn_acc *)iod->rspbuf;
1355 struct nvmet_fc_tgt_queue *queue;
1358 memset(acc, 0, sizeof(*acc));
1360 if (iod->rqstdatalen < sizeof(struct fcnvme_ls_cr_conn_rqst))
1361 ret = VERR_CR_CONN_LEN;
1362 else if (rqst->desc_list_len !=
1364 sizeof(struct fcnvme_ls_cr_conn_rqst)))
1365 ret = VERR_CR_CONN_RQST_LEN;
1366 else if (rqst->associd.desc_tag != cpu_to_be32(FCNVME_LSDESC_ASSOC_ID))
1367 ret = VERR_ASSOC_ID;
1368 else if (rqst->associd.desc_len !=
1370 sizeof(struct fcnvme_lsdesc_assoc_id)))
1371 ret = VERR_ASSOC_ID_LEN;
1372 else if (rqst->connect_cmd.desc_tag !=
1373 cpu_to_be32(FCNVME_LSDESC_CREATE_CONN_CMD))
1374 ret = VERR_CR_CONN_CMD;
1375 else if (rqst->connect_cmd.desc_len !=
1377 sizeof(struct fcnvme_lsdesc_cr_conn_cmd)))
1378 ret = VERR_CR_CONN_CMD_LEN;
1379 else if (!rqst->connect_cmd.ersp_ratio ||
1380 (be16_to_cpu(rqst->connect_cmd.ersp_ratio) >=
1381 be16_to_cpu(rqst->connect_cmd.sqsize)))
1382 ret = VERR_ERSP_RATIO;
1386 iod->assoc = nvmet_fc_find_target_assoc(tgtport,
1387 be64_to_cpu(rqst->associd.association_id));
1389 ret = VERR_NO_ASSOC;
1391 queue = nvmet_fc_alloc_target_queue(iod->assoc,
1392 be16_to_cpu(rqst->connect_cmd.qid),
1393 be16_to_cpu(rqst->connect_cmd.sqsize));
1395 ret = VERR_QUEUE_ALLOC_FAIL;
1397 /* release get taken in nvmet_fc_find_target_assoc */
1398 nvmet_fc_tgt_a_put(iod->assoc);
1403 dev_err(tgtport->dev,
1404 "Create Connection LS failed: %s\n",
1405 validation_errors[ret]);
1406 iod->lsreq->rsplen = nvmet_fc_format_rjt(acc,
1407 NVME_FC_MAX_LS_BUFFER_SIZE, rqst->w0.ls_cmd,
1408 (ret == VERR_NO_ASSOC) ?
1409 FCNVME_RJT_RC_INV_ASSOC :
1410 FCNVME_RJT_RC_LOGIC,
1411 FCNVME_RJT_EXP_NONE, 0);
1415 queue->ersp_ratio = be16_to_cpu(rqst->connect_cmd.ersp_ratio);
1416 atomic_set(&queue->connected, 1);
1417 queue->sqhd = 0; /* best place to init value */
1419 /* format a response */
1421 iod->lsreq->rsplen = sizeof(*acc);
1423 nvmet_fc_format_rsp_hdr(acc, FCNVME_LS_ACC,
1424 fcnvme_lsdesc_len(sizeof(struct fcnvme_ls_cr_conn_acc)),
1425 FCNVME_LS_CREATE_CONNECTION);
1426 acc->connectid.desc_tag = cpu_to_be32(FCNVME_LSDESC_CONN_ID);
1427 acc->connectid.desc_len =
1429 sizeof(struct fcnvme_lsdesc_conn_id));
1430 acc->connectid.connection_id =
1431 cpu_to_be64(nvmet_fc_makeconnid(iod->assoc,
1432 be16_to_cpu(rqst->connect_cmd.qid)));
1436 nvmet_fc_ls_disconnect(struct nvmet_fc_tgtport *tgtport,
1437 struct nvmet_fc_ls_iod *iod)
1439 struct fcnvme_ls_disconnect_rqst *rqst =
1440 (struct fcnvme_ls_disconnect_rqst *)iod->rqstbuf;
1441 struct fcnvme_ls_disconnect_acc *acc =
1442 (struct fcnvme_ls_disconnect_acc *)iod->rspbuf;
1443 struct nvmet_fc_tgt_queue *queue = NULL;
1444 struct nvmet_fc_tgt_assoc *assoc;
1446 bool del_assoc = false;
1448 memset(acc, 0, sizeof(*acc));
1450 if (iod->rqstdatalen < sizeof(struct fcnvme_ls_disconnect_rqst))
1451 ret = VERR_DISCONN_LEN;
1452 else if (rqst->desc_list_len !=
1454 sizeof(struct fcnvme_ls_disconnect_rqst)))
1455 ret = VERR_DISCONN_RQST_LEN;
1456 else if (rqst->associd.desc_tag != cpu_to_be32(FCNVME_LSDESC_ASSOC_ID))
1457 ret = VERR_ASSOC_ID;
1458 else if (rqst->associd.desc_len !=
1460 sizeof(struct fcnvme_lsdesc_assoc_id)))
1461 ret = VERR_ASSOC_ID_LEN;
1462 else if (rqst->discon_cmd.desc_tag !=
1463 cpu_to_be32(FCNVME_LSDESC_DISCONN_CMD))
1464 ret = VERR_DISCONN_CMD;
1465 else if (rqst->discon_cmd.desc_len !=
1467 sizeof(struct fcnvme_lsdesc_disconn_cmd)))
1468 ret = VERR_DISCONN_CMD_LEN;
1469 else if ((rqst->discon_cmd.scope != FCNVME_DISCONN_ASSOCIATION) &&
1470 (rqst->discon_cmd.scope != FCNVME_DISCONN_CONNECTION))
1471 ret = VERR_DISCONN_SCOPE;
1473 /* match an active association */
1474 assoc = nvmet_fc_find_target_assoc(tgtport,
1475 be64_to_cpu(rqst->associd.association_id));
1478 if (rqst->discon_cmd.scope ==
1479 FCNVME_DISCONN_CONNECTION) {
1480 queue = nvmet_fc_find_target_queue(tgtport,
1482 rqst->discon_cmd.id));
1484 nvmet_fc_tgt_a_put(assoc);
1489 ret = VERR_NO_ASSOC;
1493 dev_err(tgtport->dev,
1494 "Disconnect LS failed: %s\n",
1495 validation_errors[ret]);
1496 iod->lsreq->rsplen = nvmet_fc_format_rjt(acc,
1497 NVME_FC_MAX_LS_BUFFER_SIZE, rqst->w0.ls_cmd,
1498 (ret == VERR_NO_ASSOC) ?
1499 FCNVME_RJT_RC_INV_ASSOC :
1500 (ret == VERR_NO_CONN) ?
1501 FCNVME_RJT_RC_INV_CONN :
1502 FCNVME_RJT_RC_LOGIC,
1503 FCNVME_RJT_EXP_NONE, 0);
1507 /* format a response */
1509 iod->lsreq->rsplen = sizeof(*acc);
1511 nvmet_fc_format_rsp_hdr(acc, FCNVME_LS_ACC,
1513 sizeof(struct fcnvme_ls_disconnect_acc)),
1514 FCNVME_LS_DISCONNECT);
1517 /* are we to delete a Connection ID (queue) */
1519 int qid = queue->qid;
1521 nvmet_fc_delete_target_queue(queue);
1523 /* release the get taken by find_target_queue */
1524 nvmet_fc_tgt_q_put(queue);
1526 /* tear association down if io queue terminated */
1531 /* release get taken in nvmet_fc_find_target_assoc */
1532 nvmet_fc_tgt_a_put(iod->assoc);
1535 nvmet_fc_delete_target_assoc(iod->assoc);
1539 /* *********************** NVME Ctrl Routines **************************** */
1542 static void nvmet_fc_fcp_nvme_cmd_done(struct nvmet_req *nvme_req);
1544 static struct nvmet_fabrics_ops nvmet_fc_tgt_fcp_ops;
1547 nvmet_fc_xmt_ls_rsp_done(struct nvmefc_tgt_ls_req *lsreq)
1549 struct nvmet_fc_ls_iod *iod = lsreq->nvmet_fc_private;
1550 struct nvmet_fc_tgtport *tgtport = iod->tgtport;
1552 fc_dma_sync_single_for_cpu(tgtport->dev, iod->rspdma,
1553 NVME_FC_MAX_LS_BUFFER_SIZE, DMA_TO_DEVICE);
1554 nvmet_fc_free_ls_iod(tgtport, iod);
1555 nvmet_fc_tgtport_put(tgtport);
1559 nvmet_fc_xmt_ls_rsp(struct nvmet_fc_tgtport *tgtport,
1560 struct nvmet_fc_ls_iod *iod)
1564 fc_dma_sync_single_for_device(tgtport->dev, iod->rspdma,
1565 NVME_FC_MAX_LS_BUFFER_SIZE, DMA_TO_DEVICE);
1567 ret = tgtport->ops->xmt_ls_rsp(&tgtport->fc_target_port, iod->lsreq);
1569 nvmet_fc_xmt_ls_rsp_done(iod->lsreq);
1573 * Actual processing routine for received FC-NVME LS Requests from the LLD
1576 nvmet_fc_handle_ls_rqst(struct nvmet_fc_tgtport *tgtport,
1577 struct nvmet_fc_ls_iod *iod)
1579 struct fcnvme_ls_rqst_w0 *w0 =
1580 (struct fcnvme_ls_rqst_w0 *)iod->rqstbuf;
1582 iod->lsreq->nvmet_fc_private = iod;
1583 iod->lsreq->rspbuf = iod->rspbuf;
1584 iod->lsreq->rspdma = iod->rspdma;
1585 iod->lsreq->done = nvmet_fc_xmt_ls_rsp_done;
1586 /* Be preventative. handlers will later set to valid length */
1587 iod->lsreq->rsplen = 0;
1593 * parse request input, execute the request, and format the
1596 switch (w0->ls_cmd) {
1597 case FCNVME_LS_CREATE_ASSOCIATION:
1598 /* Creates Association and initial Admin Queue/Connection */
1599 nvmet_fc_ls_create_association(tgtport, iod);
1601 case FCNVME_LS_CREATE_CONNECTION:
1602 /* Creates an IO Queue/Connection */
1603 nvmet_fc_ls_create_connection(tgtport, iod);
1605 case FCNVME_LS_DISCONNECT:
1606 /* Terminate a Queue/Connection or the Association */
1607 nvmet_fc_ls_disconnect(tgtport, iod);
1610 iod->lsreq->rsplen = nvmet_fc_format_rjt(iod->rspbuf,
1611 NVME_FC_MAX_LS_BUFFER_SIZE, w0->ls_cmd,
1612 FCNVME_RJT_RC_INVAL, FCNVME_RJT_EXP_NONE, 0);
1615 nvmet_fc_xmt_ls_rsp(tgtport, iod);
1619 * Actual processing routine for received FC-NVME LS Requests from the LLD
1622 nvmet_fc_handle_ls_rqst_work(struct work_struct *work)
1624 struct nvmet_fc_ls_iod *iod =
1625 container_of(work, struct nvmet_fc_ls_iod, work);
1626 struct nvmet_fc_tgtport *tgtport = iod->tgtport;
1628 nvmet_fc_handle_ls_rqst(tgtport, iod);
1633 * nvmet_fc_rcv_ls_req - transport entry point called by an LLDD
1634 * upon the reception of a NVME LS request.
1636 * The nvmet-fc layer will copy payload to an internal structure for
1637 * processing. As such, upon completion of the routine, the LLDD may
1638 * immediately free/reuse the LS request buffer passed in the call.
1640 * If this routine returns error, the LLDD should abort the exchange.
1642 * @tgtport: pointer to the (registered) target port the LS was
1644 * @lsreq: pointer to a lsreq request structure to be used to reference
1645 * the exchange corresponding to the LS.
1646 * @lsreqbuf: pointer to the buffer containing the LS Request
1647 * @lsreqbuf_len: length, in bytes, of the received LS request
1650 nvmet_fc_rcv_ls_req(struct nvmet_fc_target_port *target_port,
1651 struct nvmefc_tgt_ls_req *lsreq,
1652 void *lsreqbuf, u32 lsreqbuf_len)
1654 struct nvmet_fc_tgtport *tgtport = targetport_to_tgtport(target_port);
1655 struct nvmet_fc_ls_iod *iod;
1657 if (lsreqbuf_len > NVME_FC_MAX_LS_BUFFER_SIZE)
1660 if (!nvmet_fc_tgtport_get(tgtport))
1663 iod = nvmet_fc_alloc_ls_iod(tgtport);
1665 nvmet_fc_tgtport_put(tgtport);
1671 memcpy(iod->rqstbuf, lsreqbuf, lsreqbuf_len);
1672 iod->rqstdatalen = lsreqbuf_len;
1674 schedule_work(&iod->work);
1678 EXPORT_SYMBOL_GPL(nvmet_fc_rcv_ls_req);
1682 * **********************
1683 * Start of FCP handling
1684 * **********************
1688 nvmet_fc_alloc_tgt_pgs(struct nvmet_fc_fcp_iod *fod)
1690 struct scatterlist *sg;
1693 u32 page_len, length;
1696 length = fod->total_length;
1697 nent = DIV_ROUND_UP(length, PAGE_SIZE);
1698 sg = kmalloc_array(nent, sizeof(struct scatterlist), GFP_KERNEL);
1702 sg_init_table(sg, nent);
1705 page_len = min_t(u32, length, PAGE_SIZE);
1707 page = alloc_page(GFP_KERNEL);
1709 goto out_free_pages;
1711 sg_set_page(&sg[i], page, page_len, 0);
1717 fod->data_sg_cnt = nent;
1718 fod->data_sg_cnt = fc_dma_map_sg(fod->tgtport->dev, sg, nent,
1719 ((fod->io_dir == NVMET_FCP_WRITE) ?
1720 DMA_FROM_DEVICE : DMA_TO_DEVICE));
1721 /* note: write from initiator perspective */
1722 fod->next_sg = fod->data_sg;
1729 __free_page(sg_page(&sg[i]));
1732 fod->data_sg = NULL;
1733 fod->data_sg_cnt = 0;
1735 return NVME_SC_INTERNAL;
1739 nvmet_fc_free_tgt_pgs(struct nvmet_fc_fcp_iod *fod)
1741 struct scatterlist *sg;
1744 if (!fod->data_sg || !fod->data_sg_cnt)
1747 fc_dma_unmap_sg(fod->tgtport->dev, fod->data_sg, fod->data_sg_cnt,
1748 ((fod->io_dir == NVMET_FCP_WRITE) ?
1749 DMA_FROM_DEVICE : DMA_TO_DEVICE));
1750 for_each_sg(fod->data_sg, sg, fod->data_sg_cnt, count)
1751 __free_page(sg_page(sg));
1752 kfree(fod->data_sg);
1753 fod->data_sg = NULL;
1754 fod->data_sg_cnt = 0;
1759 queue_90percent_full(struct nvmet_fc_tgt_queue *q, u32 sqhd)
1763 /* egad, this is ugly. And sqtail is just a best guess */
1764 sqtail = atomic_read(&q->sqtail) % q->sqsize;
1766 used = (sqtail < sqhd) ? (sqtail + q->sqsize - sqhd) : (sqtail - sqhd);
1767 return ((used * 10) >= (((u32)(q->sqsize - 1) * 9)));
1772 * May be a NVMET_FCOP_RSP or NVMET_FCOP_READDATA_RSP op
1775 nvmet_fc_prep_fcp_rsp(struct nvmet_fc_tgtport *tgtport,
1776 struct nvmet_fc_fcp_iod *fod)
1778 struct nvme_fc_ersp_iu *ersp = &fod->rspiubuf;
1779 struct nvme_common_command *sqe = &fod->cmdiubuf.sqe.common;
1780 struct nvme_completion *cqe = &ersp->cqe;
1781 u32 *cqewd = (u32 *)cqe;
1782 bool send_ersp = false;
1783 u32 rsn, rspcnt, xfr_length;
1785 if (fod->fcpreq->op == NVMET_FCOP_READDATA_RSP)
1786 xfr_length = fod->total_length;
1788 xfr_length = fod->offset;
1791 * check to see if we can send a 0's rsp.
1792 * Note: to send a 0's response, the NVME-FC host transport will
1793 * recreate the CQE. The host transport knows: sq id, SQHD (last
1794 * seen in an ersp), and command_id. Thus it will create a
1795 * zero-filled CQE with those known fields filled in. Transport
1796 * must send an ersp for any condition where the cqe won't match
1799 * Here are the FC-NVME mandated cases where we must send an ersp:
1800 * every N responses, where N=ersp_ratio
1801 * force fabric commands to send ersp's (not in FC-NVME but good
1803 * normal cmds: any time status is non-zero, or status is zero
1804 * but words 0 or 1 are non-zero.
1805 * the SQ is 90% or more full
1806 * the cmd is a fused command
1807 * transferred data length not equal to cmd iu length
1809 rspcnt = atomic_inc_return(&fod->queue->zrspcnt);
1810 if (!(rspcnt % fod->queue->ersp_ratio) ||
1811 sqe->opcode == nvme_fabrics_command ||
1812 xfr_length != fod->total_length ||
1813 (le16_to_cpu(cqe->status) & 0xFFFE) || cqewd[0] || cqewd[1] ||
1814 (sqe->flags & (NVME_CMD_FUSE_FIRST | NVME_CMD_FUSE_SECOND)) ||
1815 queue_90percent_full(fod->queue, le16_to_cpu(cqe->sq_head)))
1818 /* re-set the fields */
1819 fod->fcpreq->rspaddr = ersp;
1820 fod->fcpreq->rspdma = fod->rspdma;
1823 memset(ersp, 0, NVME_FC_SIZEOF_ZEROS_RSP);
1824 fod->fcpreq->rsplen = NVME_FC_SIZEOF_ZEROS_RSP;
1826 ersp->iu_len = cpu_to_be16(sizeof(*ersp)/sizeof(u32));
1827 rsn = atomic_inc_return(&fod->queue->rsn);
1828 ersp->rsn = cpu_to_be32(rsn);
1829 ersp->xfrd_len = cpu_to_be32(xfr_length);
1830 fod->fcpreq->rsplen = sizeof(*ersp);
1833 fc_dma_sync_single_for_device(tgtport->dev, fod->rspdma,
1834 sizeof(fod->rspiubuf), DMA_TO_DEVICE);
1837 static void nvmet_fc_xmt_fcp_op_done(struct nvmefc_tgt_fcp_req *fcpreq);
1840 nvmet_fc_abort_op(struct nvmet_fc_tgtport *tgtport,
1841 struct nvmet_fc_fcp_iod *fod)
1843 struct nvmefc_tgt_fcp_req *fcpreq = fod->fcpreq;
1845 /* data no longer needed */
1846 nvmet_fc_free_tgt_pgs(fod);
1849 * if an ABTS was received or we issued the fcp_abort early
1850 * don't call abort routine again.
1852 /* no need to take lock - lock was taken earlier to get here */
1854 tgtport->ops->fcp_abort(&tgtport->fc_target_port, fcpreq);
1856 nvmet_fc_free_fcp_iod(fod->queue, fod);
1860 nvmet_fc_xmt_fcp_rsp(struct nvmet_fc_tgtport *tgtport,
1861 struct nvmet_fc_fcp_iod *fod)
1865 fod->fcpreq->op = NVMET_FCOP_RSP;
1866 fod->fcpreq->timeout = 0;
1868 nvmet_fc_prep_fcp_rsp(tgtport, fod);
1870 ret = tgtport->ops->fcp_op(&tgtport->fc_target_port, fod->fcpreq);
1872 nvmet_fc_abort_op(tgtport, fod);
1876 nvmet_fc_transfer_fcp_data(struct nvmet_fc_tgtport *tgtport,
1877 struct nvmet_fc_fcp_iod *fod, u8 op)
1879 struct nvmefc_tgt_fcp_req *fcpreq = fod->fcpreq;
1880 struct scatterlist *sg = fod->next_sg;
1881 unsigned long flags;
1882 u32 remaininglen = fod->total_length - fod->offset;
1887 fcpreq->offset = fod->offset;
1888 fcpreq->timeout = NVME_FC_TGTOP_TIMEOUT_SEC;
1891 * for next sequence:
1892 * break at a sg element boundary
1893 * attempt to keep sequence length capped at
1894 * NVMET_FC_MAX_SEQ_LENGTH but allow sequence to
1895 * be longer if a single sg element is larger
1896 * than that amount. This is done to avoid creating
1897 * a new sg list to use for the tgtport api.
1901 while (tlen < remaininglen &&
1902 fcpreq->sg_cnt < tgtport->max_sg_cnt &&
1903 tlen + sg_dma_len(sg) < NVMET_FC_MAX_SEQ_LENGTH) {
1905 tlen += sg_dma_len(sg);
1908 if (tlen < remaininglen && fcpreq->sg_cnt == 0) {
1910 tlen += min_t(u32, sg_dma_len(sg), remaininglen);
1913 if (tlen < remaininglen)
1916 fod->next_sg = NULL;
1918 fcpreq->transfer_length = tlen;
1919 fcpreq->transferred_length = 0;
1920 fcpreq->fcp_error = 0;
1924 * If the last READDATA request: check if LLDD supports
1925 * combined xfr with response.
1927 if ((op == NVMET_FCOP_READDATA) &&
1928 ((fod->offset + fcpreq->transfer_length) == fod->total_length) &&
1929 (tgtport->ops->target_features & NVMET_FCTGTFEAT_READDATA_RSP)) {
1930 fcpreq->op = NVMET_FCOP_READDATA_RSP;
1931 nvmet_fc_prep_fcp_rsp(tgtport, fod);
1934 ret = tgtport->ops->fcp_op(&tgtport->fc_target_port, fod->fcpreq);
1937 * should be ok to set w/o lock as its in the thread of
1938 * execution (not an async timer routine) and doesn't
1939 * contend with any clearing action
1943 if (op == NVMET_FCOP_WRITEDATA) {
1944 spin_lock_irqsave(&fod->flock, flags);
1945 fod->writedataactive = false;
1946 spin_unlock_irqrestore(&fod->flock, flags);
1947 nvmet_req_complete(&fod->req, NVME_SC_INTERNAL);
1948 } else /* NVMET_FCOP_READDATA or NVMET_FCOP_READDATA_RSP */ {
1949 fcpreq->fcp_error = ret;
1950 fcpreq->transferred_length = 0;
1951 nvmet_fc_xmt_fcp_op_done(fod->fcpreq);
1957 __nvmet_fc_fod_op_abort(struct nvmet_fc_fcp_iod *fod, bool abort)
1959 struct nvmefc_tgt_fcp_req *fcpreq = fod->fcpreq;
1960 struct nvmet_fc_tgtport *tgtport = fod->tgtport;
1962 /* if in the middle of an io and we need to tear down */
1964 if (fcpreq->op == NVMET_FCOP_WRITEDATA) {
1965 nvmet_req_complete(&fod->req, NVME_SC_INTERNAL);
1969 nvmet_fc_abort_op(tgtport, fod);
1977 * actual done handler for FCP operations when completed by the lldd
1980 nvmet_fc_fod_op_done(struct nvmet_fc_fcp_iod *fod)
1982 struct nvmefc_tgt_fcp_req *fcpreq = fod->fcpreq;
1983 struct nvmet_fc_tgtport *tgtport = fod->tgtport;
1984 unsigned long flags;
1987 spin_lock_irqsave(&fod->flock, flags);
1989 fod->writedataactive = false;
1990 spin_unlock_irqrestore(&fod->flock, flags);
1992 switch (fcpreq->op) {
1994 case NVMET_FCOP_WRITEDATA:
1995 if (__nvmet_fc_fod_op_abort(fod, abort))
1997 if (fcpreq->fcp_error ||
1998 fcpreq->transferred_length != fcpreq->transfer_length) {
1999 spin_lock_irqsave(&fod->flock, flags);
2001 spin_unlock_irqrestore(&fod->flock, flags);
2003 nvmet_req_complete(&fod->req, NVME_SC_INTERNAL);
2007 fod->offset += fcpreq->transferred_length;
2008 if (fod->offset != fod->total_length) {
2009 spin_lock_irqsave(&fod->flock, flags);
2010 fod->writedataactive = true;
2011 spin_unlock_irqrestore(&fod->flock, flags);
2013 /* transfer the next chunk */
2014 nvmet_fc_transfer_fcp_data(tgtport, fod,
2015 NVMET_FCOP_WRITEDATA);
2019 /* data transfer complete, resume with nvmet layer */
2021 fod->req.execute(&fod->req);
2025 case NVMET_FCOP_READDATA:
2026 case NVMET_FCOP_READDATA_RSP:
2027 if (__nvmet_fc_fod_op_abort(fod, abort))
2029 if (fcpreq->fcp_error ||
2030 fcpreq->transferred_length != fcpreq->transfer_length) {
2031 nvmet_fc_abort_op(tgtport, fod);
2037 if (fcpreq->op == NVMET_FCOP_READDATA_RSP) {
2038 /* data no longer needed */
2039 nvmet_fc_free_tgt_pgs(fod);
2040 nvmet_fc_free_fcp_iod(fod->queue, fod);
2044 fod->offset += fcpreq->transferred_length;
2045 if (fod->offset != fod->total_length) {
2046 /* transfer the next chunk */
2047 nvmet_fc_transfer_fcp_data(tgtport, fod,
2048 NVMET_FCOP_READDATA);
2052 /* data transfer complete, send response */
2054 /* data no longer needed */
2055 nvmet_fc_free_tgt_pgs(fod);
2057 nvmet_fc_xmt_fcp_rsp(tgtport, fod);
2061 case NVMET_FCOP_RSP:
2062 if (__nvmet_fc_fod_op_abort(fod, abort))
2064 nvmet_fc_free_fcp_iod(fod->queue, fod);
2073 nvmet_fc_fcp_rqst_op_done_work(struct work_struct *work)
2075 struct nvmet_fc_fcp_iod *fod =
2076 container_of(work, struct nvmet_fc_fcp_iod, done_work);
2078 nvmet_fc_fod_op_done(fod);
2082 nvmet_fc_xmt_fcp_op_done(struct nvmefc_tgt_fcp_req *fcpreq)
2084 struct nvmet_fc_fcp_iod *fod = fcpreq->nvmet_fc_private;
2085 struct nvmet_fc_tgt_queue *queue = fod->queue;
2087 if (fod->tgtport->ops->target_features & NVMET_FCTGTFEAT_OPDONE_IN_ISR)
2088 /* context switch so completion is not in ISR context */
2089 queue_work_on(queue->cpu, queue->work_q, &fod->done_work);
2091 nvmet_fc_fod_op_done(fod);
2095 * actual completion handler after execution by the nvmet layer
2098 __nvmet_fc_fcp_nvme_cmd_done(struct nvmet_fc_tgtport *tgtport,
2099 struct nvmet_fc_fcp_iod *fod, int status)
2101 struct nvme_common_command *sqe = &fod->cmdiubuf.sqe.common;
2102 struct nvme_completion *cqe = &fod->rspiubuf.cqe;
2103 unsigned long flags;
2106 spin_lock_irqsave(&fod->flock, flags);
2108 spin_unlock_irqrestore(&fod->flock, flags);
2110 /* if we have a CQE, snoop the last sq_head value */
2112 fod->queue->sqhd = cqe->sq_head;
2115 nvmet_fc_abort_op(tgtport, fod);
2119 /* if an error handling the cmd post initial parsing */
2121 /* fudge up a failed CQE status for our transport error */
2122 memset(cqe, 0, sizeof(*cqe));
2123 cqe->sq_head = fod->queue->sqhd; /* echo last cqe sqhd */
2124 cqe->sq_id = cpu_to_le16(fod->queue->qid);
2125 cqe->command_id = sqe->command_id;
2126 cqe->status = cpu_to_le16(status);
2130 * try to push the data even if the SQE status is non-zero.
2131 * There may be a status where data still was intended to
2134 if ((fod->io_dir == NVMET_FCP_READ) && (fod->data_sg_cnt)) {
2135 /* push the data over before sending rsp */
2136 nvmet_fc_transfer_fcp_data(tgtport, fod,
2137 NVMET_FCOP_READDATA);
2141 /* writes & no data - fall thru */
2144 /* data no longer needed */
2145 nvmet_fc_free_tgt_pgs(fod);
2147 nvmet_fc_xmt_fcp_rsp(tgtport, fod);
2152 nvmet_fc_fcp_nvme_cmd_done(struct nvmet_req *nvme_req)
2154 struct nvmet_fc_fcp_iod *fod = nvmet_req_to_fod(nvme_req);
2155 struct nvmet_fc_tgtport *tgtport = fod->tgtport;
2157 __nvmet_fc_fcp_nvme_cmd_done(tgtport, fod, 0);
2162 * Actual processing routine for received FC-NVME LS Requests from the LLD
2165 nvmet_fc_handle_fcp_rqst(struct nvmet_fc_tgtport *tgtport,
2166 struct nvmet_fc_fcp_iod *fod)
2168 struct nvme_fc_cmd_iu *cmdiu = &fod->cmdiubuf;
2172 * Fused commands are currently not supported in the linux
2175 * As such, the implementation of the FC transport does not
2176 * look at the fused commands and order delivery to the upper
2177 * layer until we have both based on csn.
2180 fod->fcpreq->done = nvmet_fc_xmt_fcp_op_done;
2182 fod->total_length = be32_to_cpu(cmdiu->data_len);
2183 if (cmdiu->flags & FCNVME_CMD_FLAGS_WRITE) {
2184 fod->io_dir = NVMET_FCP_WRITE;
2185 if (!nvme_is_write(&cmdiu->sqe))
2186 goto transport_error;
2187 } else if (cmdiu->flags & FCNVME_CMD_FLAGS_READ) {
2188 fod->io_dir = NVMET_FCP_READ;
2189 if (nvme_is_write(&cmdiu->sqe))
2190 goto transport_error;
2192 fod->io_dir = NVMET_FCP_NODATA;
2193 if (fod->total_length)
2194 goto transport_error;
2197 fod->req.cmd = &fod->cmdiubuf.sqe;
2198 fod->req.rsp = &fod->rspiubuf.cqe;
2199 fod->req.port = fod->queue->port;
2201 /* ensure nvmet handlers will set cmd handler callback */
2202 fod->req.execute = NULL;
2204 /* clear any response payload */
2205 memset(&fod->rspiubuf, 0, sizeof(fod->rspiubuf));
2207 fod->data_sg = NULL;
2208 fod->data_sg_cnt = 0;
2210 ret = nvmet_req_init(&fod->req,
2211 &fod->queue->nvme_cq,
2212 &fod->queue->nvme_sq,
2213 &nvmet_fc_tgt_fcp_ops);
2215 /* bad SQE content or invalid ctrl state */
2216 /* nvmet layer has already called op done to send rsp. */
2220 /* keep a running counter of tail position */
2221 atomic_inc(&fod->queue->sqtail);
2223 if (fod->total_length) {
2224 ret = nvmet_fc_alloc_tgt_pgs(fod);
2226 nvmet_req_complete(&fod->req, ret);
2230 fod->req.sg = fod->data_sg;
2231 fod->req.sg_cnt = fod->data_sg_cnt;
2234 if (fod->io_dir == NVMET_FCP_WRITE) {
2235 /* pull the data over before invoking nvmet layer */
2236 nvmet_fc_transfer_fcp_data(tgtport, fod, NVMET_FCOP_WRITEDATA);
2243 * can invoke the nvmet_layer now. If read data, cmd completion will
2247 fod->req.execute(&fod->req);
2252 nvmet_fc_abort_op(tgtport, fod);
2256 * Actual processing routine for received FC-NVME LS Requests from the LLD
2259 nvmet_fc_handle_fcp_rqst_work(struct work_struct *work)
2261 struct nvmet_fc_fcp_iod *fod =
2262 container_of(work, struct nvmet_fc_fcp_iod, work);
2263 struct nvmet_fc_tgtport *tgtport = fod->tgtport;
2265 nvmet_fc_handle_fcp_rqst(tgtport, fod);
2269 * nvmet_fc_rcv_fcp_req - transport entry point called by an LLDD
2270 * upon the reception of a NVME FCP CMD IU.
2272 * Pass a FC-NVME FCP CMD IU received from the FC link to the nvmet-fc
2273 * layer for processing.
2275 * The nvmet_fc layer allocates a local job structure (struct
2276 * nvmet_fc_fcp_iod) from the queue for the io and copies the
2277 * CMD IU buffer to the job structure. As such, on a successful
2278 * completion (returns 0), the LLDD may immediately free/reuse
2279 * the CMD IU buffer passed in the call.
2281 * However, in some circumstances, due to the packetized nature of FC
2282 * and the api of the FC LLDD which may issue a hw command to send the
2283 * response, but the LLDD may not get the hw completion for that command
2284 * and upcall the nvmet_fc layer before a new command may be
2285 * asynchronously received - its possible for a command to be received
2286 * before the LLDD and nvmet_fc have recycled the job structure. It gives
2287 * the appearance of more commands received than fits in the sq.
2288 * To alleviate this scenario, a temporary queue is maintained in the
2289 * transport for pending LLDD requests waiting for a queue job structure.
2290 * In these "overrun" cases, a temporary queue element is allocated
2291 * the LLDD request and CMD iu buffer information remembered, and the
2292 * routine returns a -EOVERFLOW status. Subsequently, when a queue job
2293 * structure is freed, it is immediately reallocated for anything on the
2294 * pending request list. The LLDDs defer_rcv() callback is called,
2295 * informing the LLDD that it may reuse the CMD IU buffer, and the io
2296 * is then started normally with the transport.
2298 * The LLDD, when receiving an -EOVERFLOW completion status, is to treat
2299 * the completion as successful but must not reuse the CMD IU buffer
2300 * until the LLDD's defer_rcv() callback has been called for the
2301 * corresponding struct nvmefc_tgt_fcp_req pointer.
2303 * If there is any other condition in which an error occurs, the
2304 * transport will return a non-zero status indicating the error.
2305 * In all cases other than -EOVERFLOW, the transport has not accepted the
2306 * request and the LLDD should abort the exchange.
2308 * @target_port: pointer to the (registered) target port the FCP CMD IU
2310 * @fcpreq: pointer to a fcpreq request structure to be used to reference
2311 * the exchange corresponding to the FCP Exchange.
2312 * @cmdiubuf: pointer to the buffer containing the FCP CMD IU
2313 * @cmdiubuf_len: length, in bytes, of the received FCP CMD IU
2316 nvmet_fc_rcv_fcp_req(struct nvmet_fc_target_port *target_port,
2317 struct nvmefc_tgt_fcp_req *fcpreq,
2318 void *cmdiubuf, u32 cmdiubuf_len)
2320 struct nvmet_fc_tgtport *tgtport = targetport_to_tgtport(target_port);
2321 struct nvme_fc_cmd_iu *cmdiu = cmdiubuf;
2322 struct nvmet_fc_tgt_queue *queue;
2323 struct nvmet_fc_fcp_iod *fod;
2324 struct nvmet_fc_defer_fcp_req *deferfcp;
2325 unsigned long flags;
2327 /* validate iu, so the connection id can be used to find the queue */
2328 if ((cmdiubuf_len != sizeof(*cmdiu)) ||
2329 (cmdiu->scsi_id != NVME_CMD_SCSI_ID) ||
2330 (cmdiu->fc_id != NVME_CMD_FC_ID) ||
2331 (be16_to_cpu(cmdiu->iu_len) != (sizeof(*cmdiu)/4)))
2334 queue = nvmet_fc_find_target_queue(tgtport,
2335 be64_to_cpu(cmdiu->connection_id));
2340 * note: reference taken by find_target_queue
2341 * After successful fod allocation, the fod will inherit the
2342 * ownership of that reference and will remove the reference
2343 * when the fod is freed.
2346 spin_lock_irqsave(&queue->qlock, flags);
2348 fod = nvmet_fc_alloc_fcp_iod(queue);
2350 spin_unlock_irqrestore(&queue->qlock, flags);
2352 fcpreq->nvmet_fc_private = fod;
2353 fod->fcpreq = fcpreq;
2355 memcpy(&fod->cmdiubuf, cmdiubuf, cmdiubuf_len);
2357 nvmet_fc_queue_fcp_req(tgtport, queue, fcpreq);
2362 if (!tgtport->ops->defer_rcv) {
2363 spin_unlock_irqrestore(&queue->qlock, flags);
2364 /* release the queue lookup reference */
2365 nvmet_fc_tgt_q_put(queue);
2369 deferfcp = list_first_entry_or_null(&queue->avail_defer_list,
2370 struct nvmet_fc_defer_fcp_req, req_list);
2372 /* Just re-use one that was previously allocated */
2373 list_del(&deferfcp->req_list);
2375 spin_unlock_irqrestore(&queue->qlock, flags);
2377 /* Now we need to dynamically allocate one */
2378 deferfcp = kmalloc(sizeof(*deferfcp), GFP_KERNEL);
2380 /* release the queue lookup reference */
2381 nvmet_fc_tgt_q_put(queue);
2384 spin_lock_irqsave(&queue->qlock, flags);
2387 /* For now, use rspaddr / rsplen to save payload information */
2388 fcpreq->rspaddr = cmdiubuf;
2389 fcpreq->rsplen = cmdiubuf_len;
2390 deferfcp->fcp_req = fcpreq;
2392 /* defer processing till a fod becomes available */
2393 list_add_tail(&deferfcp->req_list, &queue->pending_cmd_list);
2395 /* NOTE: the queue lookup reference is still valid */
2397 spin_unlock_irqrestore(&queue->qlock, flags);
2401 EXPORT_SYMBOL_GPL(nvmet_fc_rcv_fcp_req);
2404 * nvmet_fc_rcv_fcp_abort - transport entry point called by an LLDD
2405 * upon the reception of an ABTS for a FCP command
2407 * Notify the transport that an ABTS has been received for a FCP command
2408 * that had been given to the transport via nvmet_fc_rcv_fcp_req(). The
2409 * LLDD believes the command is still being worked on
2410 * (template_ops->fcp_req_release() has not been called).
2412 * The transport will wait for any outstanding work (an op to the LLDD,
2413 * which the lldd should complete with error due to the ABTS; or the
2414 * completion from the nvmet layer of the nvme command), then will
2415 * stop processing and call the nvmet_fc_rcv_fcp_req() callback to
2416 * return the i/o context to the LLDD. The LLDD may send the BA_ACC
2417 * to the ABTS either after return from this function (assuming any
2418 * outstanding op work has been terminated) or upon the callback being
2421 * @target_port: pointer to the (registered) target port the FCP CMD IU
2423 * @fcpreq: pointer to the fcpreq request structure that corresponds
2424 * to the exchange that received the ABTS.
2427 nvmet_fc_rcv_fcp_abort(struct nvmet_fc_target_port *target_port,
2428 struct nvmefc_tgt_fcp_req *fcpreq)
2430 struct nvmet_fc_fcp_iod *fod = fcpreq->nvmet_fc_private;
2431 struct nvmet_fc_tgt_queue *queue;
2432 unsigned long flags;
2434 if (!fod || fod->fcpreq != fcpreq)
2435 /* job appears to have already completed, ignore abort */
2440 spin_lock_irqsave(&queue->qlock, flags);
2443 * mark as abort. The abort handler, invoked upon completion
2444 * of any work, will detect the aborted status and do the
2447 spin_lock(&fod->flock);
2449 fod->aborted = true;
2450 spin_unlock(&fod->flock);
2452 spin_unlock_irqrestore(&queue->qlock, flags);
2454 EXPORT_SYMBOL_GPL(nvmet_fc_rcv_fcp_abort);
2457 struct nvmet_fc_traddr {
2463 __nvme_fc_parse_u64(substring_t *sstr, u64 *val)
2467 if (match_u64(sstr, &token64))
2475 * This routine validates and extracts the WWN's from the TRADDR string.
2476 * As kernel parsers need the 0x to determine number base, universally
2477 * build string to parse with 0x prefix before parsing name strings.
2480 nvme_fc_parse_traddr(struct nvmet_fc_traddr *traddr, char *buf, size_t blen)
2482 char name[2 + NVME_FC_TRADDR_HEXNAMELEN + 1];
2483 substring_t wwn = { name, &name[sizeof(name)-1] };
2484 int nnoffset, pnoffset;
2486 /* validate it string one of the 2 allowed formats */
2487 if (strnlen(buf, blen) == NVME_FC_TRADDR_MAXLENGTH &&
2488 !strncmp(buf, "nn-0x", NVME_FC_TRADDR_OXNNLEN) &&
2489 !strncmp(&buf[NVME_FC_TRADDR_MAX_PN_OFFSET],
2490 "pn-0x", NVME_FC_TRADDR_OXNNLEN)) {
2491 nnoffset = NVME_FC_TRADDR_OXNNLEN;
2492 pnoffset = NVME_FC_TRADDR_MAX_PN_OFFSET +
2493 NVME_FC_TRADDR_OXNNLEN;
2494 } else if ((strnlen(buf, blen) == NVME_FC_TRADDR_MINLENGTH &&
2495 !strncmp(buf, "nn-", NVME_FC_TRADDR_NNLEN) &&
2496 !strncmp(&buf[NVME_FC_TRADDR_MIN_PN_OFFSET],
2497 "pn-", NVME_FC_TRADDR_NNLEN))) {
2498 nnoffset = NVME_FC_TRADDR_NNLEN;
2499 pnoffset = NVME_FC_TRADDR_MIN_PN_OFFSET + NVME_FC_TRADDR_NNLEN;
2505 name[2 + NVME_FC_TRADDR_HEXNAMELEN] = 0;
2507 memcpy(&name[2], &buf[nnoffset], NVME_FC_TRADDR_HEXNAMELEN);
2508 if (__nvme_fc_parse_u64(&wwn, &traddr->nn))
2511 memcpy(&name[2], &buf[pnoffset], NVME_FC_TRADDR_HEXNAMELEN);
2512 if (__nvme_fc_parse_u64(&wwn, &traddr->pn))
2518 pr_warn("%s: bad traddr string\n", __func__);
2523 nvmet_fc_add_port(struct nvmet_port *port)
2525 struct nvmet_fc_tgtport *tgtport;
2526 struct nvmet_fc_traddr traddr = { 0L, 0L };
2527 unsigned long flags;
2530 /* validate the address info */
2531 if ((port->disc_addr.trtype != NVMF_TRTYPE_FC) ||
2532 (port->disc_addr.adrfam != NVMF_ADDR_FAMILY_FC))
2535 /* map the traddr address info to a target port */
2537 ret = nvme_fc_parse_traddr(&traddr, port->disc_addr.traddr,
2538 sizeof(port->disc_addr.traddr));
2543 spin_lock_irqsave(&nvmet_fc_tgtlock, flags);
2544 list_for_each_entry(tgtport, &nvmet_fc_target_list, tgt_list) {
2545 if ((tgtport->fc_target_port.node_name == traddr.nn) &&
2546 (tgtport->fc_target_port.port_name == traddr.pn)) {
2547 /* a FC port can only be 1 nvmet port id */
2548 if (!tgtport->port) {
2549 tgtport->port = port;
2550 port->priv = tgtport;
2551 nvmet_fc_tgtport_get(tgtport);
2558 spin_unlock_irqrestore(&nvmet_fc_tgtlock, flags);
2563 nvmet_fc_remove_port(struct nvmet_port *port)
2565 struct nvmet_fc_tgtport *tgtport = port->priv;
2566 unsigned long flags;
2567 bool matched = false;
2569 spin_lock_irqsave(&nvmet_fc_tgtlock, flags);
2570 if (tgtport->port == port) {
2572 tgtport->port = NULL;
2574 spin_unlock_irqrestore(&nvmet_fc_tgtlock, flags);
2577 nvmet_fc_tgtport_put(tgtport);
2580 static struct nvmet_fabrics_ops nvmet_fc_tgt_fcp_ops = {
2581 .owner = THIS_MODULE,
2582 .type = NVMF_TRTYPE_FC,
2584 .add_port = nvmet_fc_add_port,
2585 .remove_port = nvmet_fc_remove_port,
2586 .queue_response = nvmet_fc_fcp_nvme_cmd_done,
2587 .delete_ctrl = nvmet_fc_delete_ctrl,
2590 static int __init nvmet_fc_init_module(void)
2592 return nvmet_register_transport(&nvmet_fc_tgt_fcp_ops);
2595 static void __exit nvmet_fc_exit_module(void)
2597 /* sanity check - all lports should be removed */
2598 if (!list_empty(&nvmet_fc_target_list))
2599 pr_warn("%s: targetport list not empty\n", __func__);
2601 nvmet_unregister_transport(&nvmet_fc_tgt_fcp_ops);
2603 ida_destroy(&nvmet_fc_tgtport_cnt);
2606 module_init(nvmet_fc_init_module);
2607 module_exit(nvmet_fc_exit_module);
2609 MODULE_LICENSE("GPL v2");