linux/drivers/nvme/target/loop.c
<<
>>
Prefs
   1/*
   2 * NVMe over Fabrics loopback device.
   3 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
   4 *
   5 * This program is free software; you can redistribute it and/or modify it
   6 * under the terms and conditions of the GNU General Public License,
   7 * version 2, as published by the Free Software Foundation.
   8 *
   9 * This program is distributed in the hope it will be useful, but WITHOUT
  10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12 * more details.
  13 */
  14#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  15#include <linux/scatterlist.h>
  16#include <linux/blk-mq.h>
  17#include <linux/nvme.h>
  18#include <linux/module.h>
  19#include <linux/parser.h>
  20#include "nvmet.h"
  21#include "../host/nvme.h"
  22#include "../host/fabrics.h"
  23
  24#define NVME_LOOP_MAX_SEGMENTS          256
  25
  26/*
  27 * We handle AEN commands ourselves and don't even let the
  28 * block layer know about them.
  29 */
  30#define NVME_LOOP_NR_AEN_COMMANDS       1
  31#define NVME_LOOP_AQ_BLKMQ_DEPTH        \
  32        (NVME_AQ_DEPTH - NVME_LOOP_NR_AEN_COMMANDS)
  33
  34struct nvme_loop_iod {
  35        struct nvme_request     nvme_req;
  36        struct nvme_command     cmd;
  37        struct nvme_completion  rsp;
  38        struct nvmet_req        req;
  39        struct nvme_loop_queue  *queue;
  40        struct work_struct      work;
  41        struct sg_table         sg_table;
  42        struct scatterlist      first_sgl[];
  43};
  44
  45struct nvme_loop_ctrl {
  46        struct nvme_loop_queue  *queues;
  47
  48        struct blk_mq_tag_set   admin_tag_set;
  49
  50        struct list_head        list;
  51        struct blk_mq_tag_set   tag_set;
  52        struct nvme_loop_iod    async_event_iod;
  53        struct nvme_ctrl        ctrl;
  54
  55        struct nvmet_ctrl       *target_ctrl;
  56        struct work_struct      delete_work;
  57};
  58
  59static inline struct nvme_loop_ctrl *to_loop_ctrl(struct nvme_ctrl *ctrl)
  60{
  61        return container_of(ctrl, struct nvme_loop_ctrl, ctrl);
  62}
  63
  64struct nvme_loop_queue {
  65        struct nvmet_cq         nvme_cq;
  66        struct nvmet_sq         nvme_sq;
  67        struct nvme_loop_ctrl   *ctrl;
  68};
  69
  70static struct nvmet_port *nvmet_loop_port;
  71
  72static LIST_HEAD(nvme_loop_ctrl_list);
  73static DEFINE_MUTEX(nvme_loop_ctrl_mutex);
  74
  75static void nvme_loop_queue_response(struct nvmet_req *nvme_req);
  76static void nvme_loop_delete_ctrl(struct nvmet_ctrl *ctrl);
  77
  78static struct nvmet_fabrics_ops nvme_loop_ops;
  79
  80static inline int nvme_loop_queue_idx(struct nvme_loop_queue *queue)
  81{
  82        return queue - queue->ctrl->queues;
  83}
  84
  85static void nvme_loop_complete_rq(struct request *req)
  86{
  87        struct nvme_loop_iod *iod = blk_mq_rq_to_pdu(req);
  88
  89        nvme_cleanup_cmd(req);
  90        sg_free_table_chained(&iod->sg_table, true);
  91        nvme_complete_rq(req);
  92}
  93
  94static struct blk_mq_tags *nvme_loop_tagset(struct nvme_loop_queue *queue)
  95{
  96        u32 queue_idx = nvme_loop_queue_idx(queue);
  97
  98        if (queue_idx == 0)
  99                return queue->ctrl->admin_tag_set.tags[queue_idx];
 100        return queue->ctrl->tag_set.tags[queue_idx - 1];
 101}
 102
 103static void nvme_loop_queue_response(struct nvmet_req *req)
 104{
 105        struct nvme_loop_queue *queue =
 106                container_of(req->sq, struct nvme_loop_queue, nvme_sq);
 107        struct nvme_completion *cqe = req->rsp;
 108
 109        /*
 110         * AEN requests are special as they don't time out and can
 111         * survive any kind of queue freeze and often don't respond to
 112         * aborts.  We don't even bother to allocate a struct request
 113         * for them but rather special case them here.
 114         */
 115        if (unlikely(nvme_loop_queue_idx(queue) == 0 &&
 116                        cqe->command_id >= NVME_LOOP_AQ_BLKMQ_DEPTH)) {
 117                nvme_complete_async_event(&queue->ctrl->ctrl, cqe->status,
 118                                &cqe->result);
 119        } else {
 120                struct request *rq;
 121
 122                rq = blk_mq_tag_to_rq(nvme_loop_tagset(queue), cqe->command_id);
 123                if (!rq) {
 124                        dev_err(queue->ctrl->ctrl.device,
 125                                "tag 0x%x on queue %d not found\n",
 126                                cqe->command_id, nvme_loop_queue_idx(queue));
 127                        return;
 128                }
 129
 130                nvme_end_request(rq, cqe->status, cqe->result);
 131        }
 132}
 133
 134static void nvme_loop_execute_work(struct work_struct *work)
 135{
 136        struct nvme_loop_iod *iod =
 137                container_of(work, struct nvme_loop_iod, work);
 138
 139        iod->req.execute(&iod->req);
 140}
 141
 142static enum blk_eh_timer_return
 143nvme_loop_timeout(struct request *rq, bool reserved)
 144{
 145        struct nvme_loop_iod *iod = blk_mq_rq_to_pdu(rq);
 146
 147        /* queue error recovery */
 148        nvme_reset_ctrl(&iod->queue->ctrl->ctrl);
 149
 150        /* fail with DNR on admin cmd timeout */
 151        nvme_req(rq)->status = NVME_SC_ABORT_REQ | NVME_SC_DNR;
 152
 153        return BLK_EH_HANDLED;
 154}
 155
 156static blk_status_t nvme_loop_queue_rq(struct blk_mq_hw_ctx *hctx,
 157                const struct blk_mq_queue_data *bd)
 158{
 159        struct nvme_ns *ns = hctx->queue->queuedata;
 160        struct nvme_loop_queue *queue = hctx->driver_data;
 161        struct request *req = bd->rq;
 162        struct nvme_loop_iod *iod = blk_mq_rq_to_pdu(req);
 163        blk_status_t ret;
 164
 165        ret = nvme_setup_cmd(ns, req, &iod->cmd);
 166        if (ret)
 167                return ret;
 168
 169        iod->cmd.common.flags |= NVME_CMD_SGL_METABUF;
 170        iod->req.port = nvmet_loop_port;
 171        if (!nvmet_req_init(&iod->req, &queue->nvme_cq,
 172                        &queue->nvme_sq, &nvme_loop_ops)) {
 173                nvme_cleanup_cmd(req);
 174                blk_mq_start_request(req);
 175                nvme_loop_queue_response(&iod->req);
 176                return BLK_STS_OK;
 177        }
 178
 179        if (blk_rq_bytes(req)) {
 180                iod->sg_table.sgl = iod->first_sgl;
 181                if (sg_alloc_table_chained(&iod->sg_table,
 182                                blk_rq_nr_phys_segments(req),
 183                                iod->sg_table.sgl))
 184                        return BLK_STS_RESOURCE;
 185
 186                iod->req.sg = iod->sg_table.sgl;
 187                iod->req.sg_cnt = blk_rq_map_sg(req->q, req, iod->sg_table.sgl);
 188        }
 189
 190        blk_mq_start_request(req);
 191
 192        schedule_work(&iod->work);
 193        return BLK_STS_OK;
 194}
 195
 196static void nvme_loop_submit_async_event(struct nvme_ctrl *arg, int aer_idx)
 197{
 198        struct nvme_loop_ctrl *ctrl = to_loop_ctrl(arg);
 199        struct nvme_loop_queue *queue = &ctrl->queues[0];
 200        struct nvme_loop_iod *iod = &ctrl->async_event_iod;
 201
 202        memset(&iod->cmd, 0, sizeof(iod->cmd));
 203        iod->cmd.common.opcode = nvme_admin_async_event;
 204        iod->cmd.common.command_id = NVME_LOOP_AQ_BLKMQ_DEPTH;
 205        iod->cmd.common.flags |= NVME_CMD_SGL_METABUF;
 206
 207        if (!nvmet_req_init(&iod->req, &queue->nvme_cq, &queue->nvme_sq,
 208                        &nvme_loop_ops)) {
 209                dev_err(ctrl->ctrl.device, "failed async event work\n");
 210                return;
 211        }
 212
 213        schedule_work(&iod->work);
 214}
 215
 216static int nvme_loop_init_iod(struct nvme_loop_ctrl *ctrl,
 217                struct nvme_loop_iod *iod, unsigned int queue_idx)
 218{
 219        iod->req.cmd = &iod->cmd;
 220        iod->req.rsp = &iod->rsp;
 221        iod->queue = &ctrl->queues[queue_idx];
 222        INIT_WORK(&iod->work, nvme_loop_execute_work);
 223        return 0;
 224}
 225
 226static int nvme_loop_init_request(struct blk_mq_tag_set *set,
 227                struct request *req, unsigned int hctx_idx,
 228                unsigned int numa_node)
 229{
 230        struct nvme_loop_ctrl *ctrl = set->driver_data;
 231
 232        return nvme_loop_init_iod(ctrl, blk_mq_rq_to_pdu(req),
 233                        (set == &ctrl->tag_set) ? hctx_idx + 1 : 0);
 234}
 235
 236static int nvme_loop_init_hctx(struct blk_mq_hw_ctx *hctx, void *data,
 237                unsigned int hctx_idx)
 238{
 239        struct nvme_loop_ctrl *ctrl = data;
 240        struct nvme_loop_queue *queue = &ctrl->queues[hctx_idx + 1];
 241
 242        BUG_ON(hctx_idx >= ctrl->ctrl.queue_count);
 243
 244        hctx->driver_data = queue;
 245        return 0;
 246}
 247
 248static int nvme_loop_init_admin_hctx(struct blk_mq_hw_ctx *hctx, void *data,
 249                unsigned int hctx_idx)
 250{
 251        struct nvme_loop_ctrl *ctrl = data;
 252        struct nvme_loop_queue *queue = &ctrl->queues[0];
 253
 254        BUG_ON(hctx_idx != 0);
 255
 256        hctx->driver_data = queue;
 257        return 0;
 258}
 259
 260static const struct blk_mq_ops nvme_loop_mq_ops = {
 261        .queue_rq       = nvme_loop_queue_rq,
 262        .complete       = nvme_loop_complete_rq,
 263        .init_request   = nvme_loop_init_request,
 264        .init_hctx      = nvme_loop_init_hctx,
 265        .timeout        = nvme_loop_timeout,
 266};
 267
 268static const struct blk_mq_ops nvme_loop_admin_mq_ops = {
 269        .queue_rq       = nvme_loop_queue_rq,
 270        .complete       = nvme_loop_complete_rq,
 271        .init_request   = nvme_loop_init_request,
 272        .init_hctx      = nvme_loop_init_admin_hctx,
 273        .timeout        = nvme_loop_timeout,
 274};
 275
 276static void nvme_loop_destroy_admin_queue(struct nvme_loop_ctrl *ctrl)
 277{
 278        nvmet_sq_destroy(&ctrl->queues[0].nvme_sq);
 279        blk_cleanup_queue(ctrl->ctrl.admin_q);
 280        blk_mq_free_tag_set(&ctrl->admin_tag_set);
 281}
 282
 283static void nvme_loop_free_ctrl(struct nvme_ctrl *nctrl)
 284{
 285        struct nvme_loop_ctrl *ctrl = to_loop_ctrl(nctrl);
 286
 287        if (list_empty(&ctrl->list))
 288                goto free_ctrl;
 289
 290        mutex_lock(&nvme_loop_ctrl_mutex);
 291        list_del(&ctrl->list);
 292        mutex_unlock(&nvme_loop_ctrl_mutex);
 293
 294        if (nctrl->tagset) {
 295                blk_cleanup_queue(ctrl->ctrl.connect_q);
 296                blk_mq_free_tag_set(&ctrl->tag_set);
 297        }
 298        kfree(ctrl->queues);
 299        nvmf_free_options(nctrl->opts);
 300free_ctrl:
 301        kfree(ctrl);
 302}
 303
 304static void nvme_loop_destroy_io_queues(struct nvme_loop_ctrl *ctrl)
 305{
 306        int i;
 307
 308        for (i = 1; i < ctrl->ctrl.queue_count; i++)
 309                nvmet_sq_destroy(&ctrl->queues[i].nvme_sq);
 310}
 311
 312static int nvme_loop_init_io_queues(struct nvme_loop_ctrl *ctrl)
 313{
 314        struct nvmf_ctrl_options *opts = ctrl->ctrl.opts;
 315        unsigned int nr_io_queues;
 316        int ret, i;
 317
 318        nr_io_queues = min(opts->nr_io_queues, num_online_cpus());
 319        ret = nvme_set_queue_count(&ctrl->ctrl, &nr_io_queues);
 320        if (ret || !nr_io_queues)
 321                return ret;
 322
 323        dev_info(ctrl->ctrl.device, "creating %d I/O queues.\n", nr_io_queues);
 324
 325        for (i = 1; i <= nr_io_queues; i++) {
 326                ctrl->queues[i].ctrl = ctrl;
 327                ret = nvmet_sq_init(&ctrl->queues[i].nvme_sq);
 328                if (ret)
 329                        goto out_destroy_queues;
 330
 331                ctrl->ctrl.queue_count++;
 332        }
 333
 334        return 0;
 335
 336out_destroy_queues:
 337        nvme_loop_destroy_io_queues(ctrl);
 338        return ret;
 339}
 340
 341static int nvme_loop_connect_io_queues(struct nvme_loop_ctrl *ctrl)
 342{
 343        int i, ret;
 344
 345        for (i = 1; i < ctrl->ctrl.queue_count; i++) {
 346                ret = nvmf_connect_io_queue(&ctrl->ctrl, i);
 347                if (ret)
 348                        return ret;
 349        }
 350
 351        return 0;
 352}
 353
 354static int nvme_loop_configure_admin_queue(struct nvme_loop_ctrl *ctrl)
 355{
 356        int error;
 357
 358        memset(&ctrl->admin_tag_set, 0, sizeof(ctrl->admin_tag_set));
 359        ctrl->admin_tag_set.ops = &nvme_loop_admin_mq_ops;
 360        ctrl->admin_tag_set.queue_depth = NVME_LOOP_AQ_BLKMQ_DEPTH;
 361        ctrl->admin_tag_set.reserved_tags = 2; /* connect + keep-alive */
 362        ctrl->admin_tag_set.numa_node = NUMA_NO_NODE;
 363        ctrl->admin_tag_set.cmd_size = sizeof(struct nvme_loop_iod) +
 364                SG_CHUNK_SIZE * sizeof(struct scatterlist);
 365        ctrl->admin_tag_set.driver_data = ctrl;
 366        ctrl->admin_tag_set.nr_hw_queues = 1;
 367        ctrl->admin_tag_set.timeout = ADMIN_TIMEOUT;
 368
 369        ctrl->queues[0].ctrl = ctrl;
 370        error = nvmet_sq_init(&ctrl->queues[0].nvme_sq);
 371        if (error)
 372                return error;
 373        ctrl->ctrl.queue_count = 1;
 374
 375        error = blk_mq_alloc_tag_set(&ctrl->admin_tag_set);
 376        if (error)
 377                goto out_free_sq;
 378        ctrl->ctrl.admin_tagset = &ctrl->admin_tag_set;
 379
 380        ctrl->ctrl.admin_q = blk_mq_init_queue(&ctrl->admin_tag_set);
 381        if (IS_ERR(ctrl->ctrl.admin_q)) {
 382                error = PTR_ERR(ctrl->ctrl.admin_q);
 383                goto out_free_tagset;
 384        }
 385
 386        error = nvmf_connect_admin_queue(&ctrl->ctrl);
 387        if (error)
 388                goto out_cleanup_queue;
 389
 390        error = nvmf_reg_read64(&ctrl->ctrl, NVME_REG_CAP, &ctrl->ctrl.cap);
 391        if (error) {
 392                dev_err(ctrl->ctrl.device,
 393                        "prop_get NVME_REG_CAP failed\n");
 394                goto out_cleanup_queue;
 395        }
 396
 397        ctrl->ctrl.sqsize =
 398                min_t(int, NVME_CAP_MQES(ctrl->ctrl.cap), ctrl->ctrl.sqsize);
 399
 400        error = nvme_enable_ctrl(&ctrl->ctrl, ctrl->ctrl.cap);
 401        if (error)
 402                goto out_cleanup_queue;
 403
 404        ctrl->ctrl.max_hw_sectors =
 405                (NVME_LOOP_MAX_SEGMENTS - 1) << (PAGE_SHIFT - 9);
 406
 407        error = nvme_init_identify(&ctrl->ctrl);
 408        if (error)
 409                goto out_cleanup_queue;
 410
 411        return 0;
 412
 413out_cleanup_queue:
 414        blk_cleanup_queue(ctrl->ctrl.admin_q);
 415out_free_tagset:
 416        blk_mq_free_tag_set(&ctrl->admin_tag_set);
 417out_free_sq:
 418        nvmet_sq_destroy(&ctrl->queues[0].nvme_sq);
 419        return error;
 420}
 421
 422static void nvme_loop_shutdown_ctrl(struct nvme_loop_ctrl *ctrl)
 423{
 424        if (ctrl->ctrl.queue_count > 1) {
 425                nvme_stop_queues(&ctrl->ctrl);
 426                blk_mq_tagset_busy_iter(&ctrl->tag_set,
 427                                        nvme_cancel_request, &ctrl->ctrl);
 428                nvme_loop_destroy_io_queues(ctrl);
 429        }
 430
 431        if (ctrl->ctrl.state == NVME_CTRL_LIVE)
 432                nvme_shutdown_ctrl(&ctrl->ctrl);
 433
 434        blk_mq_quiesce_queue(ctrl->ctrl.admin_q);
 435        blk_mq_tagset_busy_iter(&ctrl->admin_tag_set,
 436                                nvme_cancel_request, &ctrl->ctrl);
 437        blk_mq_unquiesce_queue(ctrl->ctrl.admin_q);
 438        nvme_loop_destroy_admin_queue(ctrl);
 439}
 440
 441static void nvme_loop_del_ctrl_work(struct work_struct *work)
 442{
 443        struct nvme_loop_ctrl *ctrl = container_of(work,
 444                                struct nvme_loop_ctrl, delete_work);
 445
 446        nvme_stop_ctrl(&ctrl->ctrl);
 447        nvme_remove_namespaces(&ctrl->ctrl);
 448        nvme_loop_shutdown_ctrl(ctrl);
 449        nvme_uninit_ctrl(&ctrl->ctrl);
 450        nvme_put_ctrl(&ctrl->ctrl);
 451}
 452
 453static int __nvme_loop_del_ctrl(struct nvme_loop_ctrl *ctrl)
 454{
 455        if (!nvme_change_ctrl_state(&ctrl->ctrl, NVME_CTRL_DELETING))
 456                return -EBUSY;
 457
 458        if (!queue_work(nvme_wq, &ctrl->delete_work))
 459                return -EBUSY;
 460
 461        return 0;
 462}
 463
 464static int nvme_loop_del_ctrl(struct nvme_ctrl *nctrl)
 465{
 466        struct nvme_loop_ctrl *ctrl = to_loop_ctrl(nctrl);
 467        int ret;
 468
 469        ret = __nvme_loop_del_ctrl(ctrl);
 470        if (ret)
 471                return ret;
 472
 473        flush_work(&ctrl->delete_work);
 474
 475        return 0;
 476}
 477
 478static void nvme_loop_delete_ctrl(struct nvmet_ctrl *nctrl)
 479{
 480        struct nvme_loop_ctrl *ctrl;
 481
 482        mutex_lock(&nvme_loop_ctrl_mutex);
 483        list_for_each_entry(ctrl, &nvme_loop_ctrl_list, list) {
 484                if (ctrl->ctrl.cntlid == nctrl->cntlid)
 485                        __nvme_loop_del_ctrl(ctrl);
 486        }
 487        mutex_unlock(&nvme_loop_ctrl_mutex);
 488}
 489
 490static void nvme_loop_reset_ctrl_work(struct work_struct *work)
 491{
 492        struct nvme_loop_ctrl *ctrl =
 493                container_of(work, struct nvme_loop_ctrl, ctrl.reset_work);
 494        bool changed;
 495        int ret;
 496
 497        nvme_stop_ctrl(&ctrl->ctrl);
 498        nvme_loop_shutdown_ctrl(ctrl);
 499
 500        ret = nvme_loop_configure_admin_queue(ctrl);
 501        if (ret)
 502                goto out_disable;
 503
 504        ret = nvme_loop_init_io_queues(ctrl);
 505        if (ret)
 506                goto out_destroy_admin;
 507
 508        ret = nvme_loop_connect_io_queues(ctrl);
 509        if (ret)
 510                goto out_destroy_io;
 511
 512        blk_mq_update_nr_hw_queues(&ctrl->tag_set,
 513                        ctrl->ctrl.queue_count - 1);
 514
 515        changed = nvme_change_ctrl_state(&ctrl->ctrl, NVME_CTRL_LIVE);
 516        WARN_ON_ONCE(!changed);
 517
 518        nvme_start_ctrl(&ctrl->ctrl);
 519
 520        return;
 521
 522out_destroy_io:
 523        nvme_loop_destroy_io_queues(ctrl);
 524out_destroy_admin:
 525        nvme_loop_destroy_admin_queue(ctrl);
 526out_disable:
 527        dev_warn(ctrl->ctrl.device, "Removing after reset failure\n");
 528        nvme_uninit_ctrl(&ctrl->ctrl);
 529        nvme_put_ctrl(&ctrl->ctrl);
 530}
 531
 532static const struct nvme_ctrl_ops nvme_loop_ctrl_ops = {
 533        .name                   = "loop",
 534        .module                 = THIS_MODULE,
 535        .flags                  = NVME_F_FABRICS,
 536        .reg_read32             = nvmf_reg_read32,
 537        .reg_read64             = nvmf_reg_read64,
 538        .reg_write32            = nvmf_reg_write32,
 539        .free_ctrl              = nvme_loop_free_ctrl,
 540        .submit_async_event     = nvme_loop_submit_async_event,
 541        .delete_ctrl            = nvme_loop_del_ctrl,
 542};
 543
 544static int nvme_loop_create_io_queues(struct nvme_loop_ctrl *ctrl)
 545{
 546        int ret;
 547
 548        ret = nvme_loop_init_io_queues(ctrl);
 549        if (ret)
 550                return ret;
 551
 552        memset(&ctrl->tag_set, 0, sizeof(ctrl->tag_set));
 553        ctrl->tag_set.ops = &nvme_loop_mq_ops;
 554        ctrl->tag_set.queue_depth = ctrl->ctrl.opts->queue_size;
 555        ctrl->tag_set.reserved_tags = 1; /* fabric connect */
 556        ctrl->tag_set.numa_node = NUMA_NO_NODE;
 557        ctrl->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
 558        ctrl->tag_set.cmd_size = sizeof(struct nvme_loop_iod) +
 559                SG_CHUNK_SIZE * sizeof(struct scatterlist);
 560        ctrl->tag_set.driver_data = ctrl;
 561        ctrl->tag_set.nr_hw_queues = ctrl->ctrl.queue_count - 1;
 562        ctrl->tag_set.timeout = NVME_IO_TIMEOUT;
 563        ctrl->ctrl.tagset = &ctrl->tag_set;
 564
 565        ret = blk_mq_alloc_tag_set(&ctrl->tag_set);
 566        if (ret)
 567                goto out_destroy_queues;
 568
 569        ctrl->ctrl.connect_q = blk_mq_init_queue(&ctrl->tag_set);
 570        if (IS_ERR(ctrl->ctrl.connect_q)) {
 571                ret = PTR_ERR(ctrl->ctrl.connect_q);
 572                goto out_free_tagset;
 573        }
 574
 575        ret = nvme_loop_connect_io_queues(ctrl);
 576        if (ret)
 577                goto out_cleanup_connect_q;
 578
 579        return 0;
 580
 581out_cleanup_connect_q:
 582        blk_cleanup_queue(ctrl->ctrl.connect_q);
 583out_free_tagset:
 584        blk_mq_free_tag_set(&ctrl->tag_set);
 585out_destroy_queues:
 586        nvme_loop_destroy_io_queues(ctrl);
 587        return ret;
 588}
 589
 590static struct nvme_ctrl *nvme_loop_create_ctrl(struct device *dev,
 591                struct nvmf_ctrl_options *opts)
 592{
 593        struct nvme_loop_ctrl *ctrl;
 594        bool changed;
 595        int ret;
 596
 597        ctrl = kzalloc(sizeof(*ctrl), GFP_KERNEL);
 598        if (!ctrl)
 599                return ERR_PTR(-ENOMEM);
 600        ctrl->ctrl.opts = opts;
 601        INIT_LIST_HEAD(&ctrl->list);
 602
 603        INIT_WORK(&ctrl->delete_work, nvme_loop_del_ctrl_work);
 604        INIT_WORK(&ctrl->ctrl.reset_work, nvme_loop_reset_ctrl_work);
 605
 606        ret = nvme_init_ctrl(&ctrl->ctrl, dev, &nvme_loop_ctrl_ops,
 607                                0 /* no quirks, we're perfect! */);
 608        if (ret)
 609                goto out_put_ctrl;
 610
 611        ret = -ENOMEM;
 612
 613        ctrl->ctrl.sqsize = opts->queue_size - 1;
 614        ctrl->ctrl.kato = opts->kato;
 615
 616        ctrl->queues = kcalloc(opts->nr_io_queues + 1, sizeof(*ctrl->queues),
 617                        GFP_KERNEL);
 618        if (!ctrl->queues)
 619                goto out_uninit_ctrl;
 620
 621        ret = nvme_loop_configure_admin_queue(ctrl);
 622        if (ret)
 623                goto out_free_queues;
 624
 625        if (opts->queue_size > ctrl->ctrl.maxcmd) {
 626                /* warn if maxcmd is lower than queue_size */
 627                dev_warn(ctrl->ctrl.device,
 628                        "queue_size %zu > ctrl maxcmd %u, clamping down\n",
 629                        opts->queue_size, ctrl->ctrl.maxcmd);
 630                opts->queue_size = ctrl->ctrl.maxcmd;
 631        }
 632
 633        if (opts->nr_io_queues) {
 634                ret = nvme_loop_create_io_queues(ctrl);
 635                if (ret)
 636                        goto out_remove_admin_queue;
 637        }
 638
 639        nvme_loop_init_iod(ctrl, &ctrl->async_event_iod, 0);
 640
 641        dev_info(ctrl->ctrl.device,
 642                 "new ctrl: \"%s\"\n", ctrl->ctrl.opts->subsysnqn);
 643
 644        kref_get(&ctrl->ctrl.kref);
 645
 646        changed = nvme_change_ctrl_state(&ctrl->ctrl, NVME_CTRL_LIVE);
 647        WARN_ON_ONCE(!changed);
 648
 649        mutex_lock(&nvme_loop_ctrl_mutex);
 650        list_add_tail(&ctrl->list, &nvme_loop_ctrl_list);
 651        mutex_unlock(&nvme_loop_ctrl_mutex);
 652
 653        nvme_start_ctrl(&ctrl->ctrl);
 654
 655        return &ctrl->ctrl;
 656
 657out_remove_admin_queue:
 658        nvme_loop_destroy_admin_queue(ctrl);
 659out_free_queues:
 660        kfree(ctrl->queues);
 661out_uninit_ctrl:
 662        nvme_uninit_ctrl(&ctrl->ctrl);
 663out_put_ctrl:
 664        nvme_put_ctrl(&ctrl->ctrl);
 665        if (ret > 0)
 666                ret = -EIO;
 667        return ERR_PTR(ret);
 668}
 669
 670static int nvme_loop_add_port(struct nvmet_port *port)
 671{
 672        /*
 673         * XXX: disalow adding more than one port so
 674         * there is no connection rejections when a
 675         * a subsystem is assigned to a port for which
 676         * loop doesn't have a pointer.
 677         * This scenario would be possible if we allowed
 678         * more than one port to be added and a subsystem
 679         * was assigned to a port other than nvmet_loop_port.
 680         */
 681
 682        if (nvmet_loop_port)
 683                return -EPERM;
 684
 685        nvmet_loop_port = port;
 686        return 0;
 687}
 688
 689static void nvme_loop_remove_port(struct nvmet_port *port)
 690{
 691        if (port == nvmet_loop_port)
 692                nvmet_loop_port = NULL;
 693}
 694
 695static struct nvmet_fabrics_ops nvme_loop_ops = {
 696        .owner          = THIS_MODULE,
 697        .type           = NVMF_TRTYPE_LOOP,
 698        .add_port       = nvme_loop_add_port,
 699        .remove_port    = nvme_loop_remove_port,
 700        .queue_response = nvme_loop_queue_response,
 701        .delete_ctrl    = nvme_loop_delete_ctrl,
 702};
 703
 704static struct nvmf_transport_ops nvme_loop_transport = {
 705        .name           = "loop",
 706        .create_ctrl    = nvme_loop_create_ctrl,
 707};
 708
 709static int __init nvme_loop_init_module(void)
 710{
 711        int ret;
 712
 713        ret = nvmet_register_transport(&nvme_loop_ops);
 714        if (ret)
 715                return ret;
 716
 717        ret = nvmf_register_transport(&nvme_loop_transport);
 718        if (ret)
 719                nvmet_unregister_transport(&nvme_loop_ops);
 720
 721        return ret;
 722}
 723
 724static void __exit nvme_loop_cleanup_module(void)
 725{
 726        struct nvme_loop_ctrl *ctrl, *next;
 727
 728        nvmf_unregister_transport(&nvme_loop_transport);
 729        nvmet_unregister_transport(&nvme_loop_ops);
 730
 731        mutex_lock(&nvme_loop_ctrl_mutex);
 732        list_for_each_entry_safe(ctrl, next, &nvme_loop_ctrl_list, list)
 733                __nvme_loop_del_ctrl(ctrl);
 734        mutex_unlock(&nvme_loop_ctrl_mutex);
 735
 736        flush_workqueue(nvme_wq);
 737}
 738
 739module_init(nvme_loop_init_module);
 740module_exit(nvme_loop_cleanup_module);
 741
 742MODULE_LICENSE("GPL v2");
 743MODULE_ALIAS("nvmet-transport-254"); /* 254 == NVMF_TRTYPE_LOOP */
 744