LCOV - code coverage report
Current view: top level - lib/nvmf - transport.c (source / functions) Hit Total Coverage
Test: ut_cov_unit.info Lines: 256 437 58.6 %
Date: 2024-07-15 16:02:44 Functions: 25 47 53.2 %

          Line data    Source code
       1             : /*   SPDX-License-Identifier: BSD-3-Clause
       2             :  *   Copyright (C) 2016 Intel Corporation. All rights reserved.
       3             :  *   Copyright (c) 2018-2019, 2021 Mellanox Technologies LTD. All rights reserved.
       4             :  *   Copyright (c) 2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
       5             :  */
       6             : 
       7             : #include "spdk/stdinc.h"
       8             : 
       9             : #include "nvmf_internal.h"
      10             : #include "transport.h"
      11             : 
      12             : #include "spdk/config.h"
      13             : #include "spdk/log.h"
      14             : #include "spdk/nvmf.h"
      15             : #include "spdk/nvmf_transport.h"
      16             : #include "spdk/queue.h"
      17             : #include "spdk/util.h"
      18             : #include "spdk_internal/usdt.h"
      19             : 
      20             : #define NVMF_TRANSPORT_DEFAULT_ASSOCIATION_TIMEOUT_IN_MS 120000
      21             : 
      22             : struct nvmf_transport_ops_list_element {
      23             :         struct spdk_nvmf_transport_ops                  ops;
      24             :         TAILQ_ENTRY(nvmf_transport_ops_list_element)    link;
      25             : };
      26             : 
      27             : TAILQ_HEAD(nvmf_transport_ops_list, nvmf_transport_ops_list_element)
      28             : g_spdk_nvmf_transport_ops = TAILQ_HEAD_INITIALIZER(g_spdk_nvmf_transport_ops);
      29             : 
      30             : static inline const struct spdk_nvmf_transport_ops *
      31          21 : nvmf_get_transport_ops(const char *transport_name)
      32             : {
      33             :         struct nvmf_transport_ops_list_element *ops;
      34          39 :         TAILQ_FOREACH(ops, &g_spdk_nvmf_transport_ops, link) {
      35          31 :                 if (strcasecmp(transport_name, ops->ops.name) == 0) {
      36          13 :                         return &ops->ops;
      37             :                 }
      38             :         }
      39           8 :         return NULL;
      40             : }
      41             : 
      42             : void
      43           6 : spdk_nvmf_transport_register(const struct spdk_nvmf_transport_ops *ops)
      44             : {
      45             :         struct nvmf_transport_ops_list_element *new_ops;
      46             : 
      47           6 :         if (nvmf_get_transport_ops(ops->name) != NULL) {
      48           0 :                 SPDK_ERRLOG("Double registering nvmf transport type %s.\n", ops->name);
      49           0 :                 assert(false);
      50             :                 return;
      51             :         }
      52             : 
      53           6 :         new_ops = calloc(1, sizeof(*new_ops));
      54           6 :         if (new_ops == NULL) {
      55           0 :                 SPDK_ERRLOG("Unable to allocate memory to register new transport type %s.\n", ops->name);
      56           0 :                 assert(false);
      57             :                 return;
      58             :         }
      59             : 
      60           6 :         new_ops->ops = *ops;
      61             : 
      62           6 :         TAILQ_INSERT_TAIL(&g_spdk_nvmf_transport_ops, new_ops, link);
      63             : }
      64             : 
      65             : const struct spdk_nvmf_transport_opts *
      66           0 : spdk_nvmf_get_transport_opts(struct spdk_nvmf_transport *transport)
      67             : {
      68           0 :         return &transport->opts;
      69             : }
      70             : 
      71             : void
      72           0 : nvmf_transport_dump_opts(struct spdk_nvmf_transport *transport, struct spdk_json_write_ctx *w,
      73             :                          bool named)
      74             : {
      75           0 :         const struct spdk_nvmf_transport_opts *opts = spdk_nvmf_get_transport_opts(transport);
      76             : 
      77           0 :         named ? spdk_json_write_named_object_begin(w, "params") : spdk_json_write_object_begin(w);
      78             : 
      79           0 :         spdk_json_write_named_string(w, "trtype", spdk_nvmf_get_transport_name(transport));
      80           0 :         spdk_json_write_named_uint32(w, "max_queue_depth", opts->max_queue_depth);
      81           0 :         spdk_json_write_named_uint32(w, "max_io_qpairs_per_ctrlr", opts->max_qpairs_per_ctrlr - 1);
      82           0 :         spdk_json_write_named_uint32(w, "in_capsule_data_size", opts->in_capsule_data_size);
      83           0 :         spdk_json_write_named_uint32(w, "max_io_size", opts->max_io_size);
      84           0 :         spdk_json_write_named_uint32(w, "io_unit_size", opts->io_unit_size);
      85           0 :         spdk_json_write_named_uint32(w, "max_aq_depth", opts->max_aq_depth);
      86           0 :         spdk_json_write_named_uint32(w, "num_shared_buffers", opts->num_shared_buffers);
      87           0 :         spdk_json_write_named_uint32(w, "buf_cache_size", opts->buf_cache_size);
      88           0 :         spdk_json_write_named_bool(w, "dif_insert_or_strip", opts->dif_insert_or_strip);
      89           0 :         spdk_json_write_named_bool(w, "zcopy", opts->zcopy);
      90             : 
      91           0 :         if (transport->ops->dump_opts) {
      92           0 :                 transport->ops->dump_opts(transport, w);
      93             :         }
      94             : 
      95           0 :         spdk_json_write_named_uint32(w, "abort_timeout_sec", opts->abort_timeout_sec);
      96           0 :         spdk_json_write_named_uint32(w, "ack_timeout", opts->ack_timeout);
      97           0 :         spdk_json_write_named_uint32(w, "data_wr_pool_size", opts->data_wr_pool_size);
      98           0 :         spdk_json_write_object_end(w);
      99           0 : }
     100             : 
     101             : void
     102           0 : nvmf_transport_listen_dump_trid(const struct spdk_nvme_transport_id *trid,
     103             :                                 struct spdk_json_write_ctx *w)
     104             : {
     105           0 :         const char *adrfam = spdk_nvme_transport_id_adrfam_str(trid->adrfam);
     106             : 
     107           0 :         spdk_json_write_named_string(w, "trtype", trid->trstring);
     108           0 :         spdk_json_write_named_string(w, "adrfam", adrfam ? adrfam : "unknown");
     109           0 :         spdk_json_write_named_string(w, "traddr", trid->traddr);
     110           0 :         spdk_json_write_named_string(w, "trsvcid", trid->trsvcid);
     111           0 : }
     112             : 
     113             : spdk_nvme_transport_type_t
     114           0 : spdk_nvmf_get_transport_type(struct spdk_nvmf_transport *transport)
     115             : {
     116           0 :         return transport->ops->type;
     117             : }
     118             : 
     119             : const char *
     120           0 : spdk_nvmf_get_transport_name(struct spdk_nvmf_transport *transport)
     121             : {
     122           0 :         return transport->ops->name;
     123             : }
     124             : 
     125             : static void
     126           8 : nvmf_transport_opts_copy(struct spdk_nvmf_transport_opts *opts,
     127             :                          struct spdk_nvmf_transport_opts *opts_src,
     128             :                          size_t opts_size)
     129             : {
     130           8 :         assert(opts);
     131           8 :         assert(opts_src);
     132             : 
     133           8 :         opts->opts_size = opts_size;
     134             : 
     135             : #define SET_FIELD(field) \
     136             :         if (offsetof(struct spdk_nvmf_transport_opts, field) + sizeof(opts->field) <= opts_size) { \
     137             :                 opts->field = opts_src->field; \
     138             :         } \
     139             : 
     140           8 :         SET_FIELD(max_queue_depth);
     141           8 :         SET_FIELD(max_qpairs_per_ctrlr);
     142           8 :         SET_FIELD(in_capsule_data_size);
     143           8 :         SET_FIELD(max_io_size);
     144           8 :         SET_FIELD(io_unit_size);
     145           8 :         SET_FIELD(max_aq_depth);
     146           8 :         SET_FIELD(buf_cache_size);
     147           8 :         SET_FIELD(num_shared_buffers);
     148           8 :         SET_FIELD(dif_insert_or_strip);
     149           8 :         SET_FIELD(abort_timeout_sec);
     150           8 :         SET_FIELD(association_timeout);
     151           8 :         SET_FIELD(transport_specific);
     152           8 :         SET_FIELD(acceptor_poll_rate);
     153           8 :         SET_FIELD(zcopy);
     154           8 :         SET_FIELD(ack_timeout);
     155           8 :         SET_FIELD(data_wr_pool_size);
     156             : 
     157             :         /* Do not remove this statement, you should always update this statement when you adding a new field,
     158             :          * and do not forget to add the SET_FIELD statement for your added field. */
     159             :         SPDK_STATIC_ASSERT(sizeof(struct spdk_nvmf_transport_opts) == 72, "Incorrect size");
     160             : 
     161             : #undef SET_FIELD
     162             : #undef FILED_CHECK
     163           8 : }
     164             : 
     165             : struct nvmf_transport_create_ctx {
     166             :         const struct spdk_nvmf_transport_ops *ops;
     167             :         struct spdk_nvmf_transport_opts opts;
     168             :         void *cb_arg;
     169             :         spdk_nvmf_transport_create_done_cb cb_fn;
     170             : };
     171             : 
     172             : static bool
     173          34 : nvmf_transport_use_iobuf(struct spdk_nvmf_transport *transport)
     174             : {
     175          34 :         return transport->opts.num_shared_buffers || transport->opts.buf_cache_size;
     176             : }
     177             : 
     178             : static void
     179           4 : nvmf_transport_create_async_done(void *cb_arg, struct spdk_nvmf_transport *transport)
     180             : {
     181           4 :         struct nvmf_transport_create_ctx *ctx = cb_arg;
     182             :         int chars_written;
     183             : 
     184           4 :         if (!transport) {
     185           0 :                 SPDK_ERRLOG("Failed to create transport.\n");
     186           0 :                 goto err;
     187             :         }
     188             : 
     189           4 :         pthread_mutex_init(&transport->mutex, NULL);
     190           4 :         TAILQ_INIT(&transport->listeners);
     191           4 :         transport->ops = ctx->ops;
     192           4 :         transport->opts = ctx->opts;
     193           4 :         chars_written = snprintf(transport->iobuf_name, MAX_MEMPOOL_NAME_LENGTH, "%s_%s", "nvmf",
     194           4 :                                  transport->ops->name);
     195           4 :         if (chars_written < 0) {
     196           0 :                 SPDK_ERRLOG("Unable to generate transport data buffer pool name.\n");
     197           0 :                 goto err;
     198             :         }
     199             : 
     200           4 :         if (nvmf_transport_use_iobuf(transport)) {
     201           3 :                 spdk_iobuf_register_module(transport->iobuf_name);
     202             :         }
     203             : 
     204           4 :         ctx->cb_fn(ctx->cb_arg, transport);
     205           4 :         free(ctx);
     206           4 :         return;
     207             : 
     208           0 : err:
     209           0 :         if (transport) {
     210           0 :                 transport->ops->destroy(transport, NULL, NULL);
     211             :         }
     212             : 
     213           0 :         ctx->cb_fn(ctx->cb_arg, NULL);
     214           0 :         free(ctx);
     215             : }
     216             : 
     217             : static void
     218           1 : _nvmf_transport_create_done(void *ctx)
     219             : {
     220           1 :         struct nvmf_transport_create_ctx *_ctx = (struct nvmf_transport_create_ctx *)ctx;
     221             : 
     222           1 :         nvmf_transport_create_async_done(_ctx, _ctx->ops->create(&_ctx->opts));
     223           1 : }
     224             : 
     225             : static int
     226           8 : nvmf_transport_create(const char *transport_name, struct spdk_nvmf_transport_opts *opts,
     227             :                       spdk_nvmf_transport_create_done_cb cb_fn, void *cb_arg, bool sync)
     228             : {
     229             :         struct nvmf_transport_create_ctx *ctx;
     230           8 :         struct spdk_iobuf_opts opts_iobuf = {};
     231             :         int rc;
     232             :         uint64_t count;
     233             : 
     234           8 :         ctx = calloc(1, sizeof(*ctx));
     235           8 :         if (!ctx) {
     236           0 :                 return -ENOMEM;
     237             :         }
     238             : 
     239           8 :         if (!opts) {
     240           0 :                 SPDK_ERRLOG("opts should not be NULL\n");
     241           0 :                 goto err;
     242             :         }
     243             : 
     244           8 :         if (!opts->opts_size) {
     245           0 :                 SPDK_ERRLOG("The opts_size in opts structure should not be zero\n");
     246           0 :                 goto err;
     247             :         }
     248             : 
     249           8 :         ctx->ops = nvmf_get_transport_ops(transport_name);
     250           8 :         if (!ctx->ops) {
     251           1 :                 SPDK_ERRLOG("Transport type '%s' unavailable.\n", transport_name);
     252           1 :                 goto err;
     253             :         }
     254             : 
     255           7 :         nvmf_transport_opts_copy(&ctx->opts, opts, opts->opts_size);
     256           7 :         if (ctx->opts.max_io_size != 0 && (!spdk_u32_is_pow2(ctx->opts.max_io_size) ||
     257           6 :                                            ctx->opts.max_io_size < 8192)) {
     258           1 :                 SPDK_ERRLOG("max_io_size %u must be a power of 2 and be greater than or equal 8KB\n",
     259             :                             ctx->opts.max_io_size);
     260           1 :                 goto err;
     261             :         }
     262             : 
     263           6 :         if (ctx->opts.max_aq_depth < SPDK_NVMF_MIN_ADMIN_MAX_SQ_SIZE) {
     264           1 :                 SPDK_ERRLOG("max_aq_depth %u is less than minimum defined by NVMf spec, use min value\n",
     265             :                             ctx->opts.max_aq_depth);
     266           1 :                 ctx->opts.max_aq_depth = SPDK_NVMF_MIN_ADMIN_MAX_SQ_SIZE;
     267             :         }
     268             : 
     269           6 :         spdk_iobuf_get_opts(&opts_iobuf, sizeof(opts_iobuf));
     270           6 :         if (ctx->opts.io_unit_size == 0) {
     271           1 :                 SPDK_ERRLOG("io_unit_size cannot be 0\n");
     272           1 :                 goto err;
     273             :         }
     274           5 :         if (ctx->opts.io_unit_size > opts_iobuf.large_bufsize) {
     275           1 :                 SPDK_ERRLOG("io_unit_size %u is larger than iobuf pool large buffer size %d\n",
     276             :                             ctx->opts.io_unit_size, opts_iobuf.large_bufsize);
     277           1 :                 goto err;
     278             :         }
     279             : 
     280           4 :         if (ctx->opts.io_unit_size <= opts_iobuf.small_bufsize) {
     281             :                 /* We'll be using the small buffer pool only */
     282           1 :                 count = opts_iobuf.small_pool_count;
     283             :         } else {
     284           3 :                 count = spdk_min(opts_iobuf.small_pool_count, opts_iobuf.large_pool_count);
     285             :         }
     286             : 
     287           4 :         if (ctx->opts.num_shared_buffers > count) {
     288           0 :                 SPDK_WARNLOG("The num_shared_buffers value (%u) is larger than the available iobuf"
     289             :                              " pool size (%lu). Please increase the iobuf pool sizes.\n",
     290             :                              ctx->opts.num_shared_buffers, count);
     291             :         }
     292             : 
     293           4 :         ctx->cb_fn = cb_fn;
     294           4 :         ctx->cb_arg = cb_arg;
     295             : 
     296             :         /* Prioritize sync create operation. */
     297           4 :         if (ctx->ops->create) {
     298           1 :                 if (sync) {
     299           1 :                         _nvmf_transport_create_done(ctx);
     300           1 :                         return 0;
     301             :                 }
     302             : 
     303           0 :                 rc = spdk_thread_send_msg(spdk_get_thread(), _nvmf_transport_create_done, ctx);
     304           0 :                 if (rc) {
     305           0 :                         goto err;
     306             :                 }
     307             : 
     308           0 :                 return 0;
     309             :         }
     310             : 
     311           3 :         assert(ctx->ops->create_async);
     312           3 :         rc = ctx->ops->create_async(&ctx->opts, nvmf_transport_create_async_done, ctx);
     313           3 :         if (rc) {
     314           0 :                 SPDK_ERRLOG("Unable to create new transport of type %s\n", transport_name);
     315           0 :                 goto err;
     316             :         }
     317             : 
     318           3 :         return 0;
     319           4 : err:
     320           4 :         free(ctx);
     321           4 :         return -1;
     322             : }
     323             : 
     324             : int
     325           7 : spdk_nvmf_transport_create_async(const char *transport_name, struct spdk_nvmf_transport_opts *opts,
     326             :                                  spdk_nvmf_transport_create_done_cb cb_fn, void *cb_arg)
     327             : {
     328           7 :         return nvmf_transport_create(transport_name, opts, cb_fn, cb_arg, false);
     329             : }
     330             : 
     331             : static void
     332           1 : nvmf_transport_create_sync_done(void *cb_arg, struct spdk_nvmf_transport *transport)
     333             : {
     334           1 :         struct spdk_nvmf_transport **_transport = cb_arg;
     335             : 
     336           1 :         *_transport = transport;
     337           1 : }
     338             : 
     339             : struct spdk_nvmf_transport *
     340           1 : spdk_nvmf_transport_create(const char *transport_name, struct spdk_nvmf_transport_opts *opts)
     341             : {
     342           1 :         struct spdk_nvmf_transport *transport = NULL;
     343             : 
     344             :         /* Current implementation supports synchronous version of create operation only. */
     345           1 :         assert(nvmf_get_transport_ops(transport_name) && nvmf_get_transport_ops(transport_name)->create);
     346             : 
     347           1 :         nvmf_transport_create(transport_name, opts, nvmf_transport_create_sync_done, &transport, true);
     348           1 :         return transport;
     349             : }
     350             : 
     351             : struct spdk_nvmf_transport *
     352          13 : spdk_nvmf_transport_get_first(struct spdk_nvmf_tgt *tgt)
     353             : {
     354          13 :         return TAILQ_FIRST(&tgt->transports);
     355             : }
     356             : 
     357             : struct spdk_nvmf_transport *
     358           1 : spdk_nvmf_transport_get_next(struct spdk_nvmf_transport *transport)
     359             : {
     360           1 :         return TAILQ_NEXT(transport, link);
     361             : }
     362             : 
     363             : int
     364           3 : spdk_nvmf_transport_destroy(struct spdk_nvmf_transport *transport,
     365             :                             spdk_nvmf_transport_destroy_done_cb cb_fn, void *cb_arg)
     366             : {
     367             :         struct spdk_nvmf_listener *listener, *listener_tmp;
     368             : 
     369           3 :         TAILQ_FOREACH_SAFE(listener, &transport->listeners, link, listener_tmp) {
     370           0 :                 TAILQ_REMOVE(&transport->listeners, listener, link);
     371           0 :                 transport->ops->stop_listen(transport, &listener->trid);
     372           0 :                 free(listener);
     373             :         }
     374             : 
     375           3 :         if (nvmf_transport_use_iobuf(transport)) {
     376           3 :                 spdk_iobuf_unregister_module(transport->iobuf_name);
     377             :         }
     378             : 
     379           3 :         pthread_mutex_destroy(&transport->mutex);
     380           3 :         return transport->ops->destroy(transport, cb_fn, cb_arg);
     381             : }
     382             : 
     383             : struct spdk_nvmf_listener *
     384          11 : nvmf_transport_find_listener(struct spdk_nvmf_transport *transport,
     385             :                              const struct spdk_nvme_transport_id *trid)
     386             : {
     387             :         struct spdk_nvmf_listener *listener;
     388             : 
     389          11 :         TAILQ_FOREACH(listener, &transport->listeners, link) {
     390           6 :                 if (spdk_nvme_transport_id_compare(&listener->trid, trid) == 0) {
     391           6 :                         return listener;
     392             :                 }
     393             :         }
     394             : 
     395           5 :         return NULL;
     396             : }
     397             : 
     398             : int
     399           3 : spdk_nvmf_transport_listen(struct spdk_nvmf_transport *transport,
     400             :                            const struct spdk_nvme_transport_id *trid, struct spdk_nvmf_listen_opts *opts)
     401             : {
     402             :         struct spdk_nvmf_listener *listener;
     403             :         int rc;
     404             : 
     405           3 :         listener = nvmf_transport_find_listener(transport, trid);
     406           3 :         if (!listener) {
     407           2 :                 listener = calloc(1, sizeof(*listener));
     408           2 :                 if (!listener) {
     409           0 :                         return -ENOMEM;
     410             :                 }
     411             : 
     412           2 :                 listener->ref = 1;
     413           2 :                 listener->trid = *trid;
     414           2 :                 TAILQ_INSERT_TAIL(&transport->listeners, listener, link);
     415           2 :                 pthread_mutex_lock(&transport->mutex);
     416           2 :                 rc = transport->ops->listen(transport, &listener->trid, opts);
     417           2 :                 pthread_mutex_unlock(&transport->mutex);
     418           2 :                 if (rc != 0) {
     419           1 :                         TAILQ_REMOVE(&transport->listeners, listener, link);
     420           1 :                         free(listener);
     421             :                 }
     422           2 :                 return rc;
     423             :         }
     424             : 
     425           1 :         ++listener->ref;
     426             : 
     427           1 :         return 0;
     428             : }
     429             : 
     430             : int
     431           3 : spdk_nvmf_transport_stop_listen(struct spdk_nvmf_transport *transport,
     432             :                                 const struct spdk_nvme_transport_id *trid)
     433             : {
     434             :         struct spdk_nvmf_listener *listener;
     435             : 
     436           3 :         listener = nvmf_transport_find_listener(transport, trid);
     437           3 :         if (!listener) {
     438           1 :                 return -ENOENT;
     439             :         }
     440             : 
     441           2 :         if (--listener->ref == 0) {
     442           1 :                 TAILQ_REMOVE(&transport->listeners, listener, link);
     443           1 :                 pthread_mutex_lock(&transport->mutex);
     444           1 :                 transport->ops->stop_listen(transport, trid);
     445           1 :                 pthread_mutex_unlock(&transport->mutex);
     446           1 :                 free(listener);
     447             :         }
     448             : 
     449           2 :         return 0;
     450             : }
     451             : 
     452             : struct nvmf_stop_listen_ctx {
     453             :         struct spdk_nvmf_transport *transport;
     454             :         struct spdk_nvme_transport_id trid;
     455             :         struct spdk_nvmf_subsystem *subsystem;
     456             :         spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn;
     457             :         void *cb_arg;
     458             : };
     459             : 
     460             : static void
     461           0 : nvmf_stop_listen_fini(struct spdk_io_channel_iter *i, int status)
     462             : {
     463             :         struct nvmf_stop_listen_ctx *ctx;
     464             :         struct spdk_nvmf_transport *transport;
     465           0 :         int rc = status;
     466             : 
     467           0 :         ctx = spdk_io_channel_iter_get_ctx(i);
     468           0 :         transport = ctx->transport;
     469           0 :         assert(transport != NULL);
     470             : 
     471           0 :         rc = spdk_nvmf_transport_stop_listen(transport, &ctx->trid);
     472           0 :         if (rc) {
     473           0 :                 SPDK_ERRLOG("Failed to stop listening on address '%s'\n", ctx->trid.traddr);
     474             :         }
     475             : 
     476           0 :         if (ctx->cb_fn) {
     477           0 :                 ctx->cb_fn(ctx->cb_arg, rc);
     478             :         }
     479           0 :         free(ctx);
     480           0 : }
     481             : 
     482             : static void nvmf_stop_listen_disconnect_qpairs(struct spdk_io_channel_iter *i);
     483             : 
     484             : static void
     485           0 : nvmf_stop_listen_disconnect_qpairs_msg(void *ctx)
     486             : {
     487           0 :         nvmf_stop_listen_disconnect_qpairs((struct spdk_io_channel_iter *)ctx);
     488           0 : }
     489             : 
     490             : static void
     491           0 : nvmf_stop_listen_disconnect_qpairs(struct spdk_io_channel_iter *i)
     492             : {
     493             :         struct nvmf_stop_listen_ctx *ctx;
     494             :         struct spdk_nvmf_poll_group *group;
     495             :         struct spdk_io_channel *ch;
     496             :         struct spdk_nvmf_qpair *qpair, *tmp_qpair;
     497           0 :         struct spdk_nvme_transport_id tmp_trid;
     498           0 :         bool qpair_found = false;
     499             : 
     500           0 :         ctx = spdk_io_channel_iter_get_ctx(i);
     501           0 :         ch = spdk_io_channel_iter_get_channel(i);
     502           0 :         group = spdk_io_channel_get_ctx(ch);
     503             : 
     504           0 :         TAILQ_FOREACH_SAFE(qpair, &group->qpairs, link, tmp_qpair) {
     505           0 :                 if (spdk_nvmf_qpair_get_listen_trid(qpair, &tmp_trid)) {
     506           0 :                         continue;
     507             :                 }
     508             : 
     509             :                 /* Skip qpairs that don't match the listen trid and subsystem pointer.  If
     510             :                  * the ctx->subsystem is NULL, it means disconnect all qpairs that match
     511             :                  * the listen trid. */
     512           0 :                 if (!spdk_nvme_transport_id_compare(&ctx->trid, &tmp_trid)) {
     513           0 :                         if (ctx->subsystem == NULL ||
     514           0 :                             (qpair->ctrlr != NULL && ctx->subsystem == qpair->ctrlr->subsys)) {
     515           0 :                                 spdk_nvmf_qpair_disconnect(qpair);
     516           0 :                                 qpair_found = true;
     517             :                         }
     518             :                 }
     519             :         }
     520           0 :         if (qpair_found) {
     521           0 :                 spdk_thread_send_msg(spdk_get_thread(), nvmf_stop_listen_disconnect_qpairs_msg, i);
     522           0 :                 return;
     523             :         }
     524             : 
     525           0 :         spdk_for_each_channel_continue(i, 0);
     526             : }
     527             : 
     528             : int
     529           0 : spdk_nvmf_transport_stop_listen_async(struct spdk_nvmf_transport *transport,
     530             :                                       const struct spdk_nvme_transport_id *trid,
     531             :                                       struct spdk_nvmf_subsystem *subsystem,
     532             :                                       spdk_nvmf_tgt_subsystem_listen_done_fn cb_fn,
     533             :                                       void *cb_arg)
     534             : {
     535             :         struct nvmf_stop_listen_ctx *ctx;
     536             : 
     537           0 :         if (trid->subnqn[0] != '\0') {
     538           0 :                 SPDK_ERRLOG("subnqn should be empty, use subsystem pointer instead\n");
     539           0 :                 return -EINVAL;
     540             :         }
     541             : 
     542           0 :         ctx = calloc(1, sizeof(struct nvmf_stop_listen_ctx));
     543           0 :         if (ctx == NULL) {
     544           0 :                 return -ENOMEM;
     545             :         }
     546             : 
     547           0 :         ctx->trid = *trid;
     548           0 :         ctx->subsystem = subsystem;
     549           0 :         ctx->transport = transport;
     550           0 :         ctx->cb_fn = cb_fn;
     551           0 :         ctx->cb_arg = cb_arg;
     552             : 
     553           0 :         spdk_for_each_channel(transport->tgt, nvmf_stop_listen_disconnect_qpairs, ctx,
     554             :                               nvmf_stop_listen_fini);
     555             : 
     556           0 :         return 0;
     557             : }
     558             : 
     559             : void
     560           0 : nvmf_transport_listener_discover(struct spdk_nvmf_transport *transport,
     561             :                                  struct spdk_nvme_transport_id *trid,
     562             :                                  struct spdk_nvmf_discovery_log_page_entry *entry)
     563             : {
     564           0 :         transport->ops->listener_discover(transport, trid, entry);
     565           0 : }
     566             : 
     567             : struct spdk_nvmf_transport_poll_group *
     568           2 : nvmf_transport_poll_group_create(struct spdk_nvmf_transport *transport,
     569             :                                  struct spdk_nvmf_poll_group *group)
     570             : {
     571             :         struct spdk_nvmf_transport_poll_group *tgroup;
     572           2 :         struct spdk_iobuf_opts opts_iobuf = {};
     573             :         uint32_t buf_cache_size, small_cache_size, large_cache_size;
     574             :         int rc;
     575             : 
     576           2 :         pthread_mutex_lock(&transport->mutex);
     577           2 :         tgroup = transport->ops->poll_group_create(transport, group);
     578           2 :         pthread_mutex_unlock(&transport->mutex);
     579           2 :         if (!tgroup) {
     580           0 :                 return NULL;
     581             :         }
     582           2 :         tgroup->transport = transport;
     583             : 
     584           2 :         STAILQ_INIT(&tgroup->pending_buf_queue);
     585             : 
     586           2 :         if (!nvmf_transport_use_iobuf(transport)) {
     587             :                 /* We aren't going to allocate any shared buffers or cache, so just return now. */
     588           0 :                 return tgroup;
     589             :         }
     590             : 
     591           2 :         buf_cache_size = transport->opts.buf_cache_size;
     592             : 
     593             :         /* buf_cache_size of UINT32_MAX means the value should be calculated dynamically
     594             :          * based on the number of buffers in the shared pool and the number of poll groups
     595             :          * that are sharing them.  We allocate 75% of the pool for the cache, and then
     596             :          * divide that by number of poll groups to determine the buf_cache_size for this
     597             :          * poll group.
     598             :          */
     599           2 :         if (buf_cache_size == UINT32_MAX) {
     600           0 :                 uint32_t num_shared_buffers = transport->opts.num_shared_buffers;
     601             : 
     602             :                 /* Theoretically the nvmf library can dynamically add poll groups to
     603             :                  * the target, after transports have already been created.  We aren't
     604             :                  * going to try to really handle this case efficiently, just do enough
     605             :                  * here to ensure we don't divide-by-zero.
     606             :                  */
     607           0 :                 uint16_t num_poll_groups = group->tgt->num_poll_groups ? : spdk_env_get_core_count();
     608             : 
     609           0 :                 buf_cache_size = (num_shared_buffers * 3 / 4) / num_poll_groups;
     610             :         }
     611             : 
     612           2 :         spdk_iobuf_get_opts(&opts_iobuf, sizeof(opts_iobuf));
     613           2 :         small_cache_size = buf_cache_size;
     614           2 :         if (transport->opts.io_unit_size <= opts_iobuf.small_bufsize) {
     615           2 :                 large_cache_size = 0;
     616             :         } else {
     617           0 :                 large_cache_size = buf_cache_size;
     618             :         }
     619             : 
     620           2 :         tgroup->buf_cache = calloc(1, sizeof(*tgroup->buf_cache));
     621           2 :         if (!tgroup->buf_cache) {
     622           0 :                 SPDK_ERRLOG("Unable to allocate an iobuf channel in the poll group.\n");
     623           0 :                 goto err;
     624             :         }
     625             : 
     626           2 :         rc = spdk_iobuf_channel_init(tgroup->buf_cache, transport->iobuf_name, small_cache_size,
     627             :                                      large_cache_size);
     628           2 :         if (rc != 0) {
     629           0 :                 SPDK_ERRLOG("Unable to reserve the full number of buffers for the pg buffer cache.\n");
     630           0 :                 rc = spdk_iobuf_channel_init(tgroup->buf_cache, transport->iobuf_name, 0, 0);
     631           0 :                 if (rc != 0) {
     632           0 :                         SPDK_ERRLOG("Unable to create an iobuf channel in the poll group.\n");
     633           0 :                         goto err;
     634             :                 }
     635             :         }
     636             : 
     637           2 :         return tgroup;
     638           0 : err:
     639           0 :         transport->ops->poll_group_destroy(tgroup);
     640           0 :         return NULL;
     641             : }
     642             : 
     643             : struct spdk_nvmf_transport_poll_group *
     644           0 : nvmf_transport_get_optimal_poll_group(struct spdk_nvmf_transport *transport,
     645             :                                       struct spdk_nvmf_qpair *qpair)
     646             : {
     647             :         struct spdk_nvmf_transport_poll_group *tgroup;
     648             : 
     649           0 :         if (transport->ops->get_optimal_poll_group) {
     650           0 :                 pthread_mutex_lock(&transport->mutex);
     651           0 :                 tgroup = transport->ops->get_optimal_poll_group(qpair);
     652           0 :                 pthread_mutex_unlock(&transport->mutex);
     653             : 
     654           0 :                 return tgroup;
     655             :         } else {
     656           0 :                 return NULL;
     657             :         }
     658             : }
     659             : 
     660             : void
     661           2 : nvmf_transport_poll_group_destroy(struct spdk_nvmf_transport_poll_group *group)
     662             : {
     663             :         struct spdk_nvmf_transport *transport;
     664           2 :         struct spdk_iobuf_channel *ch = NULL;
     665             : 
     666           2 :         transport = group->transport;
     667             : 
     668           2 :         if (!STAILQ_EMPTY(&group->pending_buf_queue)) {
     669           0 :                 SPDK_ERRLOG("Pending I/O list wasn't empty on poll group destruction\n");
     670             :         }
     671             : 
     672           2 :         if (nvmf_transport_use_iobuf(transport)) {
     673             :                 /* The call to poll_group_destroy both frees the group memory, but also
     674             :                  * releases any remaining buffers. Cache channel pointer so we can still
     675             :                  * release the resources after the group has been freed. */
     676           2 :                 ch = group->buf_cache;
     677             :         }
     678             : 
     679           2 :         pthread_mutex_lock(&transport->mutex);
     680           2 :         transport->ops->poll_group_destroy(group);
     681           2 :         pthread_mutex_unlock(&transport->mutex);
     682             : 
     683           2 :         if (nvmf_transport_use_iobuf(transport)) {
     684           2 :                 spdk_iobuf_channel_fini(ch);
     685           2 :                 free(ch);
     686             :         }
     687           2 : }
     688             : 
     689             : int
     690           0 : nvmf_transport_poll_group_add(struct spdk_nvmf_transport_poll_group *group,
     691             :                               struct spdk_nvmf_qpair *qpair)
     692             : {
     693           0 :         if (qpair->transport) {
     694           0 :                 assert(qpair->transport == group->transport);
     695           0 :                 if (qpair->transport != group->transport) {
     696           0 :                         return -1;
     697             :                 }
     698             :         } else {
     699           0 :                 qpair->transport = group->transport;
     700             :         }
     701             : 
     702             :         SPDK_DTRACE_PROBE3(nvmf_transport_poll_group_add, qpair, qpair->qid,
     703             :                            spdk_thread_get_id(group->group->thread));
     704             : 
     705           0 :         return group->transport->ops->poll_group_add(group, qpair);
     706             : }
     707             : 
     708             : int
     709           0 : nvmf_transport_poll_group_remove(struct spdk_nvmf_transport_poll_group *group,
     710             :                                  struct spdk_nvmf_qpair *qpair)
     711             : {
     712           0 :         int rc = ENOTSUP;
     713             : 
     714             :         SPDK_DTRACE_PROBE3(nvmf_transport_poll_group_remove, qpair, qpair->qid,
     715             :                            spdk_thread_get_id(group->group->thread));
     716             : 
     717           0 :         assert(qpair->transport == group->transport);
     718           0 :         if (group->transport->ops->poll_group_remove) {
     719           0 :                 rc = group->transport->ops->poll_group_remove(group, qpair);
     720             :         }
     721             : 
     722           0 :         return rc;
     723             : }
     724             : 
     725             : int
     726           0 : nvmf_transport_poll_group_poll(struct spdk_nvmf_transport_poll_group *group)
     727             : {
     728           0 :         return group->transport->ops->poll_group_poll(group);
     729             : }
     730             : 
     731             : int
     732           0 : nvmf_transport_req_free(struct spdk_nvmf_request *req)
     733             : {
     734           0 :         return req->qpair->transport->ops->req_free(req);
     735             : }
     736             : 
     737             : int
     738           0 : nvmf_transport_req_complete(struct spdk_nvmf_request *req)
     739             : {
     740           0 :         return req->qpair->transport->ops->req_complete(req);
     741             : }
     742             : 
     743             : void
     744           0 : nvmf_transport_qpair_fini(struct spdk_nvmf_qpair *qpair,
     745             :                           spdk_nvmf_transport_qpair_fini_cb cb_fn,
     746             :                           void *cb_arg)
     747             : {
     748             :         SPDK_DTRACE_PROBE1(nvmf_transport_qpair_fini, qpair);
     749             : 
     750           0 :         qpair->transport->ops->qpair_fini(qpair, cb_fn, cb_arg);
     751           0 : }
     752             : 
     753             : int
     754           0 : nvmf_transport_qpair_get_peer_trid(struct spdk_nvmf_qpair *qpair,
     755             :                                    struct spdk_nvme_transport_id *trid)
     756             : {
     757           0 :         return qpair->transport->ops->qpair_get_peer_trid(qpair, trid);
     758             : }
     759             : 
     760             : int
     761           0 : nvmf_transport_qpair_get_local_trid(struct spdk_nvmf_qpair *qpair,
     762             :                                     struct spdk_nvme_transport_id *trid)
     763             : {
     764           0 :         return qpair->transport->ops->qpair_get_local_trid(qpair, trid);
     765             : }
     766             : 
     767             : int
     768           0 : nvmf_transport_qpair_get_listen_trid(struct spdk_nvmf_qpair *qpair,
     769             :                                      struct spdk_nvme_transport_id *trid)
     770             : {
     771           0 :         return qpair->transport->ops->qpair_get_listen_trid(qpair, trid);
     772             : }
     773             : 
     774             : void
     775           0 : nvmf_transport_qpair_abort_request(struct spdk_nvmf_qpair *qpair,
     776             :                                    struct spdk_nvmf_request *req)
     777             : {
     778           0 :         if (qpair->transport->ops->qpair_abort_request) {
     779           0 :                 qpair->transport->ops->qpair_abort_request(qpair, req);
     780             :         }
     781           0 : }
     782             : 
     783             : bool
     784           4 : spdk_nvmf_transport_opts_init(const char *transport_name,
     785             :                               struct spdk_nvmf_transport_opts *opts, size_t opts_size)
     786             : {
     787             :         const struct spdk_nvmf_transport_ops *ops;
     788           4 :         struct spdk_nvmf_transport_opts opts_local = {};
     789             : 
     790           4 :         ops = nvmf_get_transport_ops(transport_name);
     791           4 :         if (!ops) {
     792           1 :                 SPDK_ERRLOG("Transport type %s unavailable.\n", transport_name);
     793           1 :                 return false;
     794             :         }
     795             : 
     796           3 :         if (!opts) {
     797           1 :                 SPDK_ERRLOG("opts should not be NULL\n");
     798           1 :                 return false;
     799             :         }
     800             : 
     801           2 :         if (!opts_size) {
     802           1 :                 SPDK_ERRLOG("opts_size inside opts should not be zero value\n");
     803           1 :                 return false;
     804             :         }
     805             : 
     806           1 :         opts_local.association_timeout = NVMF_TRANSPORT_DEFAULT_ASSOCIATION_TIMEOUT_IN_MS;
     807           1 :         opts_local.acceptor_poll_rate = SPDK_NVMF_DEFAULT_ACCEPT_POLL_RATE_US;
     808           1 :         opts_local.disable_command_passthru = false;
     809           1 :         ops->opts_init(&opts_local);
     810             : 
     811           1 :         nvmf_transport_opts_copy(opts, &opts_local, opts_size);
     812             : 
     813           1 :         return true;
     814             : }
     815             : 
     816             : void
     817           6 : spdk_nvmf_request_free_buffers(struct spdk_nvmf_request *req,
     818             :                                struct spdk_nvmf_transport_poll_group *group,
     819             :                                struct spdk_nvmf_transport *transport)
     820             : {
     821             :         uint32_t i;
     822             : 
     823          11 :         for (i = 0; i < req->iovcnt; i++) {
     824           5 :                 spdk_iobuf_put(group->buf_cache, req->iov[i].iov_base, req->iov[i].iov_len);
     825           5 :                 req->iov[i].iov_base = NULL;
     826           5 :                 req->iov[i].iov_len = 0;
     827             :         }
     828           6 :         req->iovcnt = 0;
     829           6 :         req->data_from_pool = false;
     830           6 : }
     831             : 
     832             : typedef int (*set_buffer_callback)(struct spdk_nvmf_request *req, void *buf,
     833             :                                    uint32_t length,     uint32_t io_unit_size);
     834             : static int
     835          74 : nvmf_request_set_buffer(struct spdk_nvmf_request *req, void *buf, uint32_t length,
     836             :                         uint32_t io_unit_size)
     837             : {
     838          74 :         req->iov[req->iovcnt].iov_base = buf;
     839          74 :         req->iov[req->iovcnt].iov_len  = spdk_min(length, io_unit_size);
     840          74 :         length -= req->iov[req->iovcnt].iov_len;
     841          74 :         req->iovcnt++;
     842             : 
     843          74 :         return length;
     844             : }
     845             : 
     846             : static int
     847          25 : nvmf_request_get_buffers(struct spdk_nvmf_request *req,
     848             :                          struct spdk_nvmf_transport_poll_group *group,
     849             :                          struct spdk_nvmf_transport *transport,
     850             :                          uint32_t length, uint32_t io_unit_size,
     851             :                          set_buffer_callback cb_func)
     852             : {
     853             :         uint32_t num_buffers;
     854          25 :         uint32_t i = 0;
     855             :         void *buffer;
     856             : 
     857             :         /* If the number of buffers is too large, then we know the I/O is larger than allowed.
     858             :          *  Fail it.
     859             :          */
     860          25 :         num_buffers = SPDK_CEIL_DIV(length, io_unit_size);
     861          25 :         if (spdk_unlikely(num_buffers > NVMF_REQ_MAX_BUFFERS)) {
     862           0 :                 return -EINVAL;
     863             :         }
     864             : 
     865         105 :         while (i < num_buffers) {
     866          81 :                 buffer = spdk_iobuf_get(group->buf_cache, spdk_min(io_unit_size, length), NULL, NULL);
     867          81 :                 if (spdk_unlikely(buffer == NULL)) {
     868           1 :                         return -ENOMEM;
     869             :                 }
     870          80 :                 length = cb_func(req, buffer, length, io_unit_size);
     871          80 :                 i++;
     872             :         }
     873             : 
     874          24 :         assert(length == 0);
     875             : 
     876          24 :         return 0;
     877             : }
     878             : 
     879             : int
     880          21 : spdk_nvmf_request_get_buffers(struct spdk_nvmf_request *req,
     881             :                               struct spdk_nvmf_transport_poll_group *group,
     882             :                               struct spdk_nvmf_transport *transport,
     883             :                               uint32_t length)
     884             : {
     885             :         int rc;
     886             : 
     887          21 :         assert(nvmf_transport_use_iobuf(transport));
     888             : 
     889          21 :         req->iovcnt = 0;
     890          21 :         rc = nvmf_request_get_buffers(req, group, transport, length,
     891             :                                       transport->opts.io_unit_size,
     892             :                                       nvmf_request_set_buffer);
     893          21 :         if (spdk_likely(rc == 0)) {
     894          20 :                 req->data_from_pool = true;
     895           1 :         } else if (rc == -ENOMEM) {
     896           1 :                 spdk_nvmf_request_free_buffers(req, group, transport);
     897             :         }
     898             : 
     899          21 :         return rc;
     900             : }
     901             : 
     902             : static int
     903           6 : nvmf_request_set_stripped_buffer(struct spdk_nvmf_request *req, void *buf, uint32_t length,
     904             :                                  uint32_t io_unit_size)
     905             : {
     906           6 :         struct spdk_nvmf_stripped_data *data = req->stripped_data;
     907             : 
     908           6 :         data->iov[data->iovcnt].iov_base = buf;
     909           6 :         data->iov[data->iovcnt].iov_len  = spdk_min(length, io_unit_size);
     910           6 :         length -= data->iov[data->iovcnt].iov_len;
     911           6 :         data->iovcnt++;
     912             : 
     913           6 :         return length;
     914             : }
     915             : 
     916             : void
     917           0 : nvmf_request_free_stripped_buffers(struct spdk_nvmf_request *req,
     918             :                                    struct spdk_nvmf_transport_poll_group *group,
     919             :                                    struct spdk_nvmf_transport *transport)
     920             : {
     921           0 :         struct spdk_nvmf_stripped_data *data = req->stripped_data;
     922             :         uint32_t i;
     923             : 
     924           0 :         for (i = 0; i < data->iovcnt; i++) {
     925           0 :                 spdk_iobuf_put(group->buf_cache, data->iov[i].iov_base, data->iov[i].iov_len);
     926             :         }
     927           0 :         free(data);
     928           0 :         req->stripped_data = NULL;
     929           0 : }
     930             : 
     931             : int
     932           8 : nvmf_request_get_stripped_buffers(struct spdk_nvmf_request *req,
     933             :                                   struct spdk_nvmf_transport_poll_group *group,
     934             :                                   struct spdk_nvmf_transport *transport,
     935             :                                   uint32_t length)
     936             : {
     937           8 :         uint32_t block_size = req->dif.dif_ctx.block_size;
     938           8 :         uint32_t data_block_size = block_size - req->dif.dif_ctx.md_size;
     939           8 :         uint32_t io_unit_size = transport->opts.io_unit_size / block_size * data_block_size;
     940             :         struct spdk_nvmf_stripped_data *data;
     941             :         uint32_t i;
     942             :         int rc;
     943             : 
     944             :         /* Data blocks must be block aligned */
     945          14 :         for (i = 0; i < req->iovcnt; i++) {
     946          10 :                 if (req->iov[i].iov_len % block_size) {
     947           4 :                         return -EINVAL;
     948             :                 }
     949             :         }
     950             : 
     951           4 :         data = calloc(1, sizeof(*data));
     952           4 :         if (data == NULL) {
     953           0 :                 SPDK_ERRLOG("Unable to allocate memory for stripped_data.\n");
     954           0 :                 return -ENOMEM;
     955             :         }
     956           4 :         req->stripped_data = data;
     957           4 :         req->stripped_data->iovcnt = 0;
     958             : 
     959           4 :         rc = nvmf_request_get_buffers(req, group, transport, length, io_unit_size,
     960             :                                       nvmf_request_set_stripped_buffer);
     961           4 :         if (rc == -ENOMEM) {
     962           0 :                 nvmf_request_free_stripped_buffers(req, group, transport);
     963           0 :                 return rc;
     964             :         }
     965           4 :         return rc;
     966             : }

Generated by: LCOV version 1.15