LCOV - code coverage report
Current view: top level - spdk/test/unit/lib/nvme/nvme.c - nvme_ut.c (source / functions) Hit Total Coverage
Test: Combined Lines: 1059 1063 99.6 %
Date: 2024-08-14 09:16:26 Functions: 51 64 79.7 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 198 406 48.8 %

           Branch data     Line data    Source code
       1                 :            : /*   SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  *   Copyright (C) 2015 Intel Corporation. All rights reserved.
       3                 :            :  *   Copyright (c) 2020 Mellanox Technologies LTD. All rights reserved.
       4                 :            :  */
       5                 :            : 
       6                 :            : #include "spdk_internal/cunit.h"
       7                 :            : 
       8                 :            : #include "spdk/env.h"
       9                 :            : 
      10                 :            : #include "nvme/nvme.c"
      11                 :            : 
      12                 :            : #include "spdk_internal/mock.h"
      13                 :            : 
      14                 :            : #include "common/lib/test_env.c"
      15                 :            : 
      16                 :         40 : DEFINE_STUB_V(nvme_ctrlr_proc_get_ref, (struct spdk_nvme_ctrlr *ctrlr));
      17                 :         55 : DEFINE_STUB_V(nvme_ctrlr_proc_put_ref, (struct spdk_nvme_ctrlr *ctrlr));
      18                 :          5 : DEFINE_STUB_V(nvme_ctrlr_fail, (struct spdk_nvme_ctrlr *ctrlr, bool hotremove));
      19   [ -  +  -  + ]:         65 : DEFINE_STUB(spdk_nvme_transport_available_by_name, bool,
      20                 :            :             (const char *transport_name), true);
      21                 :            : /* return anything non-NULL, this won't be dereferenced anywhere in this test */
      22         [ -  + ]:         30 : DEFINE_STUB(nvme_ctrlr_get_current_process, struct spdk_nvme_ctrlr_process *,
      23                 :            :             (struct spdk_nvme_ctrlr *ctrlr), (struct spdk_nvme_ctrlr_process *)(uintptr_t)0x1);
      24         [ -  + ]:         15 : DEFINE_STUB(nvme_ctrlr_process_init, int,
      25                 :            :             (struct spdk_nvme_ctrlr *ctrlr), 0);
      26         [ -  + ]:         55 : DEFINE_STUB(nvme_ctrlr_get_ref_count, int,
      27                 :            :             (struct spdk_nvme_ctrlr *ctrlr), 0);
      28   [ -  +  -  + ]:         25 : DEFINE_STUB(dummy_probe_cb, bool,
      29                 :            :             (void *cb_ctx, const struct spdk_nvme_transport_id *trid,
      30                 :            :              struct spdk_nvme_ctrlr_opts *opts), false);
      31         [ -  + ]:         20 : DEFINE_STUB(nvme_transport_ctrlr_construct, struct spdk_nvme_ctrlr *,
      32                 :            :             (const struct spdk_nvme_transport_id *trid,
      33                 :            :              const struct spdk_nvme_ctrlr_opts *opts,
      34                 :            :              void *devhandle), NULL);
      35                 :         50 : DEFINE_STUB_V(nvme_io_msg_ctrlr_detach, (struct spdk_nvme_ctrlr *ctrlr));
      36   [ #  #  #  # ]:          0 : DEFINE_STUB(spdk_nvme_transport_available, bool,
      37                 :            :             (enum spdk_nvme_transport_type trtype), true);
      38         [ -  + ]:         15 : DEFINE_STUB(spdk_pci_event_listen, int, (void), 0);
      39         [ #  # ]:          0 : DEFINE_STUB(spdk_nvme_poll_group_process_completions, int64_t, (struct spdk_nvme_poll_group *group,
      40                 :            :                 uint32_t completions_per_qpair, spdk_nvme_disconnected_qpair_cb disconnected_qpair_cb), 0);
      41         [ #  # ]:          0 : DEFINE_STUB(nvme_transport_ctrlr_scan_attached, int, (struct spdk_nvme_probe_ctx *probe_ctx), 0);
      42                 :            : 
      43                 :            : static bool ut_destruct_called = false;
      44                 :            : void
      45                 :          5 : nvme_ctrlr_destruct(struct spdk_nvme_ctrlr *ctrlr)
      46                 :            : {
      47                 :          5 :         ut_destruct_called = true;
      48                 :          5 : }
      49                 :            : 
      50                 :            : void
      51                 :         50 : nvme_ctrlr_destruct_async(struct spdk_nvme_ctrlr *ctrlr, struct nvme_ctrlr_detach_ctx *ctx)
      52                 :            : {
      53                 :         50 :         ut_destruct_called = true;
      54                 :         50 :         ctrlr->is_destructed = true;
      55                 :            : 
      56                 :         50 :         ctx->shutdown_complete = true;
      57                 :         50 : }
      58                 :            : 
      59                 :            : int
      60                 :         55 : nvme_ctrlr_destruct_poll_async(struct spdk_nvme_ctrlr *ctrlr,
      61                 :            :                                struct nvme_ctrlr_detach_ctx *ctx)
      62                 :            : {
      63   [ +  +  +  + ]:         55 :         if (!ctx->shutdown_complete) {
      64                 :          5 :                 return -EAGAIN;
      65                 :            :         }
      66                 :            : 
      67         [ +  - ]:         50 :         if (ctx->cb_fn) {
      68                 :         50 :                 ctx->cb_fn(ctrlr);
      69                 :            :         }
      70                 :            : 
      71                 :         50 :         return 0;
      72                 :            : }
      73                 :            : 
      74                 :            : union spdk_nvme_csts_register
      75                 :         20 :         spdk_nvme_ctrlr_get_regs_csts(struct spdk_nvme_ctrlr *ctrlr)
      76                 :            : {
      77                 :         20 :         union spdk_nvme_csts_register csts = {};
      78                 :         20 :         return csts;
      79                 :            : }
      80                 :            : 
      81                 :            : void
      82                 :         60 : spdk_nvme_ctrlr_get_default_ctrlr_opts(struct spdk_nvme_ctrlr_opts *opts, size_t opts_size)
      83                 :            : {
      84         [ -  + ]:         60 :         memset(opts, 0, opts_size);
      85                 :         60 :         nvme_get_default_hostnqn(opts->hostnqn, sizeof(opts->hostnqn));
      86                 :         60 :         opts->opts_size = opts_size;
      87                 :         60 : }
      88                 :            : 
      89                 :            : static void
      90                 :         55 : memset_trid(struct spdk_nvme_transport_id *trid1, struct spdk_nvme_transport_id *trid2)
      91                 :            : {
      92         [ -  + ]:         55 :         memset(trid1, 0, sizeof(struct spdk_nvme_transport_id));
      93         [ -  + ]:         55 :         memset(trid2, 0, sizeof(struct spdk_nvme_transport_id));
      94                 :         55 : }
      95                 :            : 
      96                 :            : static bool ut_check_trtype = false;
      97                 :            : static bool ut_test_probe_internal = false;
      98                 :            : 
      99                 :            : static int
     100                 :          5 : ut_nvme_pcie_ctrlr_scan(struct spdk_nvme_probe_ctx *probe_ctx,
     101                 :            :                         bool direct_connect)
     102                 :            : {
     103                 :            :         struct spdk_nvme_ctrlr *ctrlr;
     104                 :          5 :         struct spdk_nvme_qpair qpair = {};
     105                 :            :         int rc;
     106                 :            : 
     107         [ -  + ]:          5 :         if (probe_ctx->trid.trtype != SPDK_NVME_TRANSPORT_PCIE) {
     108                 :          0 :                 return -1;
     109                 :            :         }
     110                 :            : 
     111                 :          5 :         ctrlr = calloc(1, sizeof(*ctrlr));
     112                 :          5 :         CU_ASSERT(ctrlr != NULL);
     113                 :          5 :         ctrlr->adminq = &qpair;
     114                 :            : 
     115                 :            :         /* happy path with first controller */
     116                 :          5 :         MOCK_SET(nvme_transport_ctrlr_construct, ctrlr);
     117                 :          5 :         rc = nvme_ctrlr_probe(&probe_ctx->trid, probe_ctx, NULL);
     118                 :          5 :         CU_ASSERT(rc == 0);
     119                 :            : 
     120                 :            :         /* failed with the second controller */
     121                 :          5 :         MOCK_SET(nvme_transport_ctrlr_construct, NULL);
     122                 :          5 :         rc = nvme_ctrlr_probe(&probe_ctx->trid, probe_ctx, NULL);
     123                 :          5 :         CU_ASSERT(rc != 0);
     124   [ -  -  -  + ]:          5 :         MOCK_CLEAR_P(nvme_transport_ctrlr_construct);
     125                 :            : 
     126                 :          5 :         return -1;
     127                 :            : }
     128                 :            : 
     129                 :            : int
     130                 :          5 : nvme_transport_ctrlr_destruct(struct spdk_nvme_ctrlr *ctrlr)
     131                 :            : {
     132                 :          5 :         free(ctrlr);
     133                 :          5 :         return 0;
     134                 :            : }
     135                 :            : 
     136                 :            : int
     137                 :         60 : nvme_transport_ctrlr_scan(struct spdk_nvme_probe_ctx *probe_ctx,
     138                 :            :                           bool direct_connect)
     139                 :            : {
     140                 :         60 :         struct spdk_nvme_ctrlr *ctrlr = NULL;
     141                 :            : 
     142   [ +  +  +  + ]:         60 :         if (ut_check_trtype == true) {
     143                 :         10 :                 CU_ASSERT(probe_ctx->trid.trtype == SPDK_NVME_TRANSPORT_PCIE);
     144                 :            :         }
     145                 :            : 
     146   [ +  +  +  + ]:         60 :         if (ut_test_probe_internal) {
     147                 :          5 :                 return ut_nvme_pcie_ctrlr_scan(probe_ctx, direct_connect);
     148                 :            :         }
     149                 :            : 
     150   [ +  +  +  + ]:         55 :         if (direct_connect == true && probe_ctx->probe_cb) {
     151                 :         20 :                 nvme_robust_mutex_unlock(&g_spdk_nvme_driver->lock);
     152                 :         20 :                 ctrlr = nvme_get_ctrlr_by_trid(&probe_ctx->trid, NULL);
     153                 :         20 :                 nvme_robust_mutex_lock(&g_spdk_nvme_driver->lock);
     154                 :         20 :                 probe_ctx->probe_cb(probe_ctx->cb_ctx, &probe_ctx->trid, &ctrlr->opts);
     155                 :            :         }
     156                 :         55 :         return 0;
     157                 :            : }
     158                 :            : 
     159                 :            : static bool ut_attach_cb_called = false;
     160                 :            : static void
     161                 :          5 : dummy_attach_cb(void *cb_ctx, const struct spdk_nvme_transport_id *trid,
     162                 :            :                 struct spdk_nvme_ctrlr *ctrlr, const struct spdk_nvme_ctrlr_opts *opts)
     163                 :            : {
     164                 :          5 :         ut_attach_cb_called = true;
     165                 :          5 : }
     166                 :            : 
     167                 :            : static void
     168                 :          5 : test_spdk_nvme_probe(void)
     169                 :            : {
     170                 :          5 :         int rc = 0;
     171                 :          5 :         const struct spdk_nvme_transport_id *trid = NULL;
     172                 :          5 :         void *cb_ctx = NULL;
     173                 :          5 :         spdk_nvme_probe_cb probe_cb = NULL;
     174                 :          5 :         spdk_nvme_attach_cb attach_cb = dummy_attach_cb;
     175                 :          5 :         spdk_nvme_remove_cb remove_cb = NULL;
     176                 :          4 :         struct spdk_nvme_ctrlr ctrlr;
     177                 :          4 :         pthread_mutexattr_t attr;
     178                 :          5 :         struct nvme_driver dummy = {};
     179                 :          5 :         g_spdk_nvme_driver = &dummy;
     180                 :            : 
     181                 :            :         /* driver init fails */
     182                 :          5 :         MOCK_SET(spdk_process_is_primary, false);
     183                 :          5 :         MOCK_SET(spdk_memzone_lookup, NULL);
     184                 :          5 :         rc = spdk_nvme_probe(trid, cb_ctx, probe_cb, attach_cb, remove_cb);
     185                 :          5 :         CU_ASSERT(rc == -1);
     186                 :            : 
     187                 :            :         /*
     188                 :            :          * For secondary processes, the attach_cb should automatically get
     189                 :            :          * called for any controllers already initialized by the primary
     190                 :            :          * process.
     191                 :            :          */
     192                 :          5 :         MOCK_SET(spdk_nvme_transport_available_by_name, false);
     193                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
     194                 :          5 :         dummy.initialized = true;
     195                 :          5 :         g_spdk_nvme_driver = &dummy;
     196                 :          5 :         rc = spdk_nvme_probe(trid, cb_ctx, probe_cb, attach_cb, remove_cb);
     197                 :          5 :         CU_ASSERT(rc == -1);
     198                 :            : 
     199                 :            :         /* driver init passes, transport available, secondary call attach_cb */
     200                 :          5 :         MOCK_SET(spdk_nvme_transport_available_by_name, true);
     201                 :          5 :         MOCK_SET(spdk_process_is_primary, false);
     202                 :          5 :         MOCK_SET(spdk_memzone_lookup, g_spdk_nvme_driver);
     203                 :          5 :         dummy.initialized = true;
     204         [ -  + ]:          5 :         memset(&ctrlr, 0, sizeof(struct spdk_nvme_ctrlr));
     205         [ -  + ]:          5 :         CU_ASSERT(pthread_mutexattr_init(&attr) == 0);
     206         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_init(&dummy.lock, &attr) == 0);
     207                 :          5 :         TAILQ_INIT(&dummy.shared_attached_ctrlrs);
     208                 :          5 :         TAILQ_INSERT_TAIL(&dummy.shared_attached_ctrlrs, &ctrlr, tailq);
     209                 :          5 :         ut_attach_cb_called = false;
     210                 :            :         /* setup nvme_transport_ctrlr_scan() stub to also check the trype */
     211                 :          5 :         ut_check_trtype = true;
     212                 :          5 :         rc = spdk_nvme_probe(trid, cb_ctx, probe_cb, attach_cb, remove_cb);
     213                 :          5 :         CU_ASSERT(rc == 0);
     214         [ -  + ]:          5 :         CU_ASSERT(ut_attach_cb_called == true);
     215                 :            : 
     216                 :            :         /* driver init passes, transport available, we are primary */
     217                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
     218                 :          5 :         rc = spdk_nvme_probe(trid, cb_ctx, probe_cb, attach_cb, remove_cb);
     219                 :          5 :         CU_ASSERT(rc == 0);
     220                 :            : 
     221                 :          5 :         g_spdk_nvme_driver = NULL;
     222                 :            :         /* reset to pre-test values */
     223   [ -  -  -  + ]:          5 :         MOCK_CLEAR(spdk_memzone_lookup);
     224                 :          5 :         ut_check_trtype = false;
     225                 :            : 
     226         [ -  + ]:          5 :         pthread_mutex_destroy(&dummy.lock);
     227         [ -  + ]:          5 :         pthread_mutexattr_destroy(&attr);
     228                 :          5 : }
     229                 :            : 
     230                 :            : static void
     231                 :          5 : test_spdk_nvme_connect(void)
     232                 :            : {
     233                 :          5 :         struct spdk_nvme_ctrlr *ret_ctrlr = NULL;
     234                 :          5 :         struct spdk_nvme_transport_id trid = {};
     235                 :          5 :         struct spdk_nvme_ctrlr_opts opts = {};
     236                 :          4 :         struct spdk_nvme_ctrlr ctrlr;
     237                 :          4 :         pthread_mutexattr_t attr;
     238                 :          5 :         struct nvme_driver dummy = {};
     239                 :            : 
     240                 :            :         /* initialize the variable to prepare the test */
     241                 :          5 :         dummy.initialized = true;
     242                 :          5 :         TAILQ_INIT(&dummy.shared_attached_ctrlrs);
     243                 :          5 :         g_spdk_nvme_driver = &dummy;
     244         [ -  + ]:          5 :         CU_ASSERT(pthread_mutexattr_init(&attr) == 0);
     245         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_init(&g_spdk_nvme_driver->lock, &attr) == 0);
     246                 :            : 
     247                 :            :         /* set NULL trid pointer to test immediate return */
     248                 :          5 :         ret_ctrlr = spdk_nvme_connect(NULL, NULL, 0);
     249                 :          5 :         CU_ASSERT(ret_ctrlr == NULL);
     250                 :            : 
     251                 :            :         /* driver init passes, transport available, secondary process connects ctrlr */
     252                 :          5 :         MOCK_SET(spdk_process_is_primary, false);
     253                 :          5 :         MOCK_SET(spdk_memzone_lookup, g_spdk_nvme_driver);
     254                 :          5 :         MOCK_SET(spdk_nvme_transport_available_by_name, true);
     255         [ -  + ]:          5 :         memset(&trid, 0, sizeof(trid));
     256                 :          5 :         trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
     257                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, NULL, 0);
     258                 :          5 :         CU_ASSERT(ret_ctrlr == NULL);
     259                 :            : 
     260                 :            :         /* driver init passes, setup one ctrlr on the attached_list */
     261         [ -  + ]:          5 :         memset(&ctrlr, 0, sizeof(struct spdk_nvme_ctrlr));
     262                 :          5 :         spdk_nvme_ctrlr_get_default_ctrlr_opts(&ctrlr.opts, sizeof(ctrlr.opts));
     263         [ -  + ]:          5 :         snprintf(ctrlr.trid.traddr, sizeof(ctrlr.trid.traddr), "0000:01:00.0");
     264                 :          5 :         ctrlr.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
     265                 :          5 :         TAILQ_INSERT_TAIL(&g_spdk_nvme_driver->shared_attached_ctrlrs, &ctrlr, tailq);
     266                 :            :         /* get the ctrlr from the attached list */
     267         [ -  + ]:          5 :         snprintf(trid.traddr, sizeof(trid.traddr), "0000:01:00.0");
     268                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, NULL, 0);
     269                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     270                 :            :         /* get the ctrlr from the attached list with default ctrlr opts */
     271                 :          5 :         ctrlr.opts.num_io_queues = DEFAULT_MAX_IO_QUEUES;
     272                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, NULL, 0);
     273                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     274                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.num_io_queues, DEFAULT_MAX_IO_QUEUES);
     275                 :            :         /* get the ctrlr from the attached list with default ctrlr opts and consistent opts_size */
     276                 :          5 :         spdk_nvme_ctrlr_get_default_ctrlr_opts(&opts, sizeof(opts));
     277                 :          5 :         opts.num_io_queues = 1;
     278                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, &opts, sizeof(opts));
     279                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     280                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.num_io_queues, 1);
     281                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.opts_size, sizeof(opts));
     282                 :            : 
     283                 :            :         /* opts_size is 0 */
     284                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, &opts, 0);
     285                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     286                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.opts_size, 0);
     287                 :            : 
     288                 :            :         /* opts_size is less than sizeof(*opts) if opts != NULL */
     289                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, &opts, 4);
     290                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     291                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.num_io_queues, 1);
     292                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.opts_size, 4);
     293                 :            :         /* remove the attached ctrlr on the attached_list */
     294                 :          5 :         MOCK_SET(nvme_ctrlr_get_ref_count, 1);
     295                 :          5 :         CU_ASSERT(spdk_nvme_detach(&ctrlr) == 0);
     296                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_spdk_nvme_driver->shared_attached_ctrlrs));
     297                 :            : 
     298                 :            :         /* driver init passes, transport available, primary process connects ctrlr */
     299                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
     300                 :            :         /* setup one ctrlr on the attached_list */
     301         [ -  + ]:          5 :         memset(&ctrlr, 0, sizeof(struct spdk_nvme_ctrlr));
     302         [ -  + ]:          5 :         snprintf(ctrlr.trid.traddr, sizeof(ctrlr.trid.traddr), "0000:02:00.0");
     303                 :          5 :         ctrlr.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
     304                 :          5 :         spdk_nvme_ctrlr_get_default_ctrlr_opts(&ctrlr.opts, sizeof(ctrlr.opts));
     305                 :          5 :         TAILQ_INSERT_TAIL(&g_spdk_nvme_driver->shared_attached_ctrlrs, &ctrlr, tailq);
     306                 :            :         /* get the ctrlr from the attached list */
     307         [ -  + ]:          5 :         snprintf(trid.traddr, sizeof(trid.traddr), "0000:02:00.0");
     308                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, NULL, 0);
     309                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     310                 :            :         /* get the ctrlr from the attached list with default ctrlr opts */
     311                 :          5 :         ctrlr.opts.num_io_queues = DEFAULT_MAX_IO_QUEUES;
     312                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, NULL, 0);
     313                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     314                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.num_io_queues, DEFAULT_MAX_IO_QUEUES);
     315                 :            :         /* get the ctrlr from the attached list with default ctrlr opts and consistent opts_size */
     316                 :          5 :         opts.num_io_queues = 2;
     317                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, &opts, sizeof(opts));
     318                 :          5 :         CU_ASSERT(ret_ctrlr == &ctrlr);
     319                 :          5 :         CU_ASSERT_EQUAL(ret_ctrlr->opts.num_io_queues, 2);
     320                 :            :         /* remove the attached ctrlr on the attached_list */
     321                 :          5 :         CU_ASSERT(spdk_nvme_detach(ret_ctrlr) == 0);
     322                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_spdk_nvme_driver->shared_attached_ctrlrs));
     323                 :            : 
     324                 :            :         /* test driver init failure return */
     325                 :          5 :         MOCK_SET(spdk_process_is_primary, false);
     326                 :          5 :         MOCK_SET(spdk_memzone_lookup, NULL);
     327                 :          5 :         ret_ctrlr = spdk_nvme_connect(&trid, NULL, 0);
     328                 :          5 :         CU_ASSERT(ret_ctrlr == NULL);
     329                 :          5 : }
     330                 :            : 
     331                 :            : static struct spdk_nvme_probe_ctx *
     332                 :         15 : test_nvme_init_get_probe_ctx(void)
     333                 :            : {
     334                 :            :         struct spdk_nvme_probe_ctx *probe_ctx;
     335                 :            : 
     336                 :         15 :         probe_ctx = calloc(1, sizeof(*probe_ctx));
     337         [ -  + ]:         15 :         SPDK_CU_ASSERT_FATAL(probe_ctx != NULL);
     338                 :         15 :         TAILQ_INIT(&probe_ctx->init_ctrlrs);
     339                 :            : 
     340                 :         15 :         return probe_ctx;
     341                 :            : }
     342                 :            : 
     343                 :            : static void
     344                 :          5 : test_nvme_init_controllers(void)
     345                 :            : {
     346                 :          5 :         int rc = 0;
     347                 :          5 :         struct nvme_driver test_driver = {};
     348                 :          5 :         void *cb_ctx = NULL;
     349                 :          5 :         spdk_nvme_attach_cb attach_cb = dummy_attach_cb;
     350                 :            :         struct spdk_nvme_probe_ctx *probe_ctx;
     351                 :            :         struct spdk_nvme_ctrlr *ctrlr;
     352                 :          4 :         pthread_mutexattr_t attr;
     353                 :            : 
     354                 :          5 :         g_spdk_nvme_driver = &test_driver;
     355                 :          5 :         ctrlr = calloc(1, sizeof(*ctrlr));
     356         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(ctrlr != NULL);
     357                 :          5 :         ctrlr->trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
     358         [ -  + ]:          5 :         CU_ASSERT(pthread_mutexattr_init(&attr) == 0);
     359         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_init(&ctrlr->ctrlr_lock, &attr) == 0);
     360         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_init(&test_driver.lock, &attr) == 0);
     361                 :          5 :         TAILQ_INIT(&test_driver.shared_attached_ctrlrs);
     362                 :            : 
     363                 :            :         /*
     364                 :            :          * Try to initialize, but nvme_ctrlr_process_init will fail.
     365                 :            :          * Verify correct behavior when it does.
     366                 :            :          */
     367                 :          5 :         MOCK_SET(nvme_ctrlr_process_init, 1);
     368                 :          5 :         MOCK_SET(spdk_process_is_primary, 1);
     369                 :          5 :         g_spdk_nvme_driver->initialized = false;
     370                 :          5 :         ut_destruct_called = false;
     371                 :          5 :         probe_ctx = test_nvme_init_get_probe_ctx();
     372                 :          5 :         TAILQ_INSERT_TAIL(&probe_ctx->init_ctrlrs, ctrlr, tailq);
     373                 :          5 :         probe_ctx->cb_ctx = cb_ctx;
     374                 :          5 :         probe_ctx->attach_cb = attach_cb;
     375                 :          5 :         probe_ctx->trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
     376                 :          5 :         rc = nvme_init_controllers(probe_ctx);
     377                 :          5 :         CU_ASSERT(rc == 0);
     378         [ -  + ]:          5 :         CU_ASSERT(g_spdk_nvme_driver->initialized == true);
     379         [ -  + ]:          5 :         CU_ASSERT(ut_destruct_called == true);
     380                 :            : 
     381                 :            :         /*
     382                 :            :          * Controller init OK, need to move the controller state machine
     383                 :            :          * forward by setting the ctrl state so that it can be moved
     384                 :            :          * the shared_attached_ctrlrs list.
     385                 :            :          */
     386                 :          5 :         probe_ctx = test_nvme_init_get_probe_ctx();
     387                 :          5 :         TAILQ_INSERT_TAIL(&probe_ctx->init_ctrlrs, ctrlr, tailq);
     388                 :          5 :         ctrlr->state = NVME_CTRLR_STATE_READY;
     389                 :          5 :         MOCK_SET(nvme_ctrlr_process_init, 0);
     390                 :          5 :         rc = nvme_init_controllers(probe_ctx);
     391                 :          5 :         CU_ASSERT(rc == 0);
     392         [ -  + ]:          5 :         CU_ASSERT(ut_attach_cb_called == true);
     393                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_nvme_attached_ctrlrs));
     394                 :          5 :         CU_ASSERT(TAILQ_FIRST(&g_spdk_nvme_driver->shared_attached_ctrlrs) == ctrlr);
     395         [ -  + ]:          5 :         TAILQ_REMOVE(&g_spdk_nvme_driver->shared_attached_ctrlrs, ctrlr, tailq);
     396                 :            : 
     397                 :            :         /*
     398                 :            :          * Reset to initial state
     399                 :            :          */
     400         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_destroy(&ctrlr->ctrlr_lock) == 0);
     401         [ -  + ]:          5 :         memset(ctrlr, 0, sizeof(struct spdk_nvme_ctrlr));
     402         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_init(&ctrlr->ctrlr_lock, &attr) == 0);
     403                 :            : 
     404                 :            :         /*
     405                 :            :          * Non-PCIe controllers should be added to the per-process list, not the shared list.
     406                 :            :          */
     407                 :          5 :         ctrlr->trid.trtype = SPDK_NVME_TRANSPORT_RDMA;
     408                 :          5 :         probe_ctx = test_nvme_init_get_probe_ctx();
     409                 :          5 :         TAILQ_INSERT_TAIL(&probe_ctx->init_ctrlrs, ctrlr, tailq);
     410                 :          5 :         ctrlr->state = NVME_CTRLR_STATE_READY;
     411                 :          5 :         MOCK_SET(nvme_ctrlr_process_init, 0);
     412                 :          5 :         rc = nvme_init_controllers(probe_ctx);
     413                 :          5 :         CU_ASSERT(rc == 0);
     414         [ -  + ]:          5 :         CU_ASSERT(ut_attach_cb_called == true);
     415                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_spdk_nvme_driver->shared_attached_ctrlrs));
     416                 :          5 :         CU_ASSERT(TAILQ_FIRST(&g_nvme_attached_ctrlrs) == ctrlr);
     417         [ -  + ]:          5 :         TAILQ_REMOVE(&g_nvme_attached_ctrlrs, ctrlr, tailq);
     418         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_destroy(&ctrlr->ctrlr_lock) == 0);
     419                 :          5 :         free(ctrlr);
     420                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_nvme_attached_ctrlrs));
     421                 :            : 
     422                 :          5 :         g_spdk_nvme_driver = NULL;
     423         [ -  + ]:          5 :         pthread_mutexattr_destroy(&attr);
     424         [ -  + ]:          5 :         pthread_mutex_destroy(&test_driver.lock);
     425                 :          5 : }
     426                 :            : 
     427                 :            : static void
     428                 :          5 : test_nvme_driver_init(void)
     429                 :            : {
     430                 :            :         int rc;
     431                 :          5 :         struct nvme_driver dummy = {};
     432                 :          5 :         g_spdk_nvme_driver = &dummy;
     433                 :            : 
     434                 :            :         /* adjust this so testing doesn't take so long */
     435                 :          5 :         g_nvme_driver_timeout_ms = 100;
     436                 :            : 
     437                 :            :         /* process is primary and mem already reserved */
     438                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
     439                 :          5 :         dummy.initialized = true;
     440                 :          5 :         rc = nvme_driver_init();
     441                 :          5 :         CU_ASSERT(rc == 0);
     442                 :            : 
     443                 :            :         /*
     444                 :            :          * Process is primary and mem not yet reserved but the call
     445                 :            :          * to spdk_memzone_reserve() returns NULL.
     446                 :            :          */
     447                 :          5 :         g_spdk_nvme_driver = NULL;
     448                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
     449                 :          5 :         MOCK_SET(spdk_memzone_reserve, NULL);
     450                 :          5 :         rc = nvme_driver_init();
     451                 :          5 :         CU_ASSERT(rc == -1);
     452                 :            : 
     453                 :            :         /* process is not primary, no mem already reserved */
     454                 :          5 :         MOCK_SET(spdk_process_is_primary, false);
     455                 :          5 :         MOCK_SET(spdk_memzone_lookup, NULL);
     456                 :          5 :         g_spdk_nvme_driver = NULL;
     457                 :          5 :         rc = nvme_driver_init();
     458                 :          5 :         CU_ASSERT(rc == -1);
     459                 :            : 
     460                 :            :         /* process is not primary, mem is already reserved & init'd */
     461                 :          5 :         MOCK_SET(spdk_process_is_primary, false);
     462                 :          5 :         MOCK_SET(spdk_memzone_lookup, (void *)&dummy);
     463                 :          5 :         dummy.initialized = true;
     464                 :          5 :         rc = nvme_driver_init();
     465                 :          5 :         CU_ASSERT(rc == 0);
     466                 :            : 
     467                 :            :         /* process is not primary, mem is reserved but not initialized */
     468                 :            :         /* and times out */
     469                 :          5 :         MOCK_SET(spdk_process_is_primary, false);
     470                 :          5 :         MOCK_SET(spdk_memzone_reserve, (void *)&dummy);
     471                 :          5 :         dummy.initialized = false;
     472                 :          5 :         rc = nvme_driver_init();
     473                 :          5 :         CU_ASSERT(rc == -1);
     474                 :            : 
     475                 :            :         /* process is primary, got mem but mutex won't init */
     476                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
     477                 :          5 :         MOCK_SET(spdk_memzone_reserve, (void *)&dummy);
     478                 :          5 :         MOCK_SET(pthread_mutexattr_init, -1);
     479                 :          5 :         g_spdk_nvme_driver = NULL;
     480                 :          5 :         dummy.initialized = true;
     481                 :          5 :         rc = nvme_driver_init();
     482                 :            :         /* for FreeBSD we can't can't effectively mock this path */
     483                 :            : #ifndef __FreeBSD__
     484                 :          5 :         CU_ASSERT(rc != 0);
     485                 :            : #else
     486                 :            :         CU_ASSERT(rc == 0);
     487                 :            : #endif
     488                 :            : 
     489                 :            :         /* process is primary, got mem, mutex OK */
     490                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
     491   [ -  -  -  + ]:          5 :         MOCK_CLEAR(pthread_mutexattr_init);
     492                 :          5 :         g_spdk_nvme_driver = NULL;
     493                 :          5 :         rc = nvme_driver_init();
     494         [ -  + ]:          5 :         CU_ASSERT(g_spdk_nvme_driver->initialized == false);
     495                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_spdk_nvme_driver->shared_attached_ctrlrs));
     496                 :          5 :         CU_ASSERT(rc == 0);
     497                 :            : 
     498                 :          5 :         g_spdk_nvme_driver = NULL;
     499   [ -  -  -  + ]:          5 :         MOCK_CLEAR(spdk_memzone_reserve);
     500   [ -  -  -  + ]:          5 :         MOCK_CLEAR(spdk_memzone_lookup);
     501                 :          5 : }
     502                 :            : 
     503                 :            : static void
     504                 :          5 : test_spdk_nvme_detach(void)
     505                 :            : {
     506                 :          5 :         int rc = 1;
     507                 :          4 :         struct spdk_nvme_ctrlr ctrlr;
     508                 :            :         struct spdk_nvme_ctrlr *ret_ctrlr;
     509                 :          5 :         struct nvme_driver test_driver = {};
     510                 :            : 
     511         [ -  + ]:          5 :         memset(&ctrlr, 0, sizeof(ctrlr));
     512                 :          5 :         ctrlr.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
     513                 :            : 
     514                 :          5 :         g_spdk_nvme_driver = &test_driver;
     515                 :          5 :         TAILQ_INIT(&test_driver.shared_attached_ctrlrs);
     516                 :          5 :         TAILQ_INSERT_TAIL(&test_driver.shared_attached_ctrlrs, &ctrlr, tailq);
     517         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_init(&test_driver.lock, NULL) == 0);
     518                 :            : 
     519                 :            :         /*
     520                 :            :          * Controllers are ref counted so mock the function that returns
     521                 :            :          * the ref count so that detach will actually call the destruct
     522                 :            :          * function which we've mocked simply to verify that it gets
     523                 :            :          * called (we aren't testing what the real destruct function does
     524                 :            :          * here.)
     525                 :            :          */
     526                 :          5 :         MOCK_SET(nvme_ctrlr_get_ref_count, 1);
     527                 :          5 :         rc = spdk_nvme_detach(&ctrlr);
     528                 :          5 :         ret_ctrlr = TAILQ_FIRST(&test_driver.shared_attached_ctrlrs);
     529                 :          5 :         CU_ASSERT(ret_ctrlr == NULL);
     530         [ -  + ]:          5 :         CU_ASSERT(ut_destruct_called == true);
     531                 :          5 :         CU_ASSERT(rc == 0);
     532                 :            : 
     533                 :            :         /*
     534                 :            :          * Mock the ref count to 1 so we confirm that the destruct
     535                 :            :          * function is not called and that attached ctrl list is
     536                 :            :          * not empty.
     537                 :            :          */
     538                 :          5 :         MOCK_SET(nvme_ctrlr_get_ref_count, 2);
     539                 :          5 :         TAILQ_INSERT_TAIL(&test_driver.shared_attached_ctrlrs, &ctrlr, tailq);
     540                 :          5 :         ut_destruct_called = false;
     541                 :          5 :         rc = spdk_nvme_detach(&ctrlr);
     542                 :          5 :         ret_ctrlr = TAILQ_FIRST(&test_driver.shared_attached_ctrlrs);
     543                 :          5 :         CU_ASSERT(ret_ctrlr != NULL);
     544         [ -  + ]:          5 :         CU_ASSERT(ut_destruct_called == false);
     545                 :          5 :         CU_ASSERT(rc == 0);
     546                 :            : 
     547                 :            :         /*
     548                 :            :          * Non-PCIe controllers should be on the per-process attached_ctrlrs list, not the
     549                 :            :          * shared_attached_ctrlrs list.  Test an RDMA controller and ensure it is removed
     550                 :            :          * from the correct list.
     551                 :            :          */
     552         [ -  + ]:          5 :         memset(&ctrlr, 0, sizeof(ctrlr));
     553                 :          5 :         ctrlr.trid.trtype = SPDK_NVME_TRANSPORT_RDMA;
     554                 :          5 :         TAILQ_INIT(&g_nvme_attached_ctrlrs);
     555                 :          5 :         TAILQ_INSERT_TAIL(&g_nvme_attached_ctrlrs, &ctrlr, tailq);
     556                 :          5 :         MOCK_SET(nvme_ctrlr_get_ref_count, 1);
     557                 :          5 :         rc = spdk_nvme_detach(&ctrlr);
     558                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_nvme_attached_ctrlrs));
     559         [ -  + ]:          5 :         CU_ASSERT(ut_destruct_called == true);
     560                 :          5 :         CU_ASSERT(rc == 0);
     561                 :            : 
     562                 :          5 :         g_spdk_nvme_driver = NULL;
     563         [ -  + ]:          5 :         pthread_mutex_destroy(&test_driver.lock);
     564                 :          5 : }
     565                 :            : 
     566                 :            : static void
     567                 :          5 : test_nvme_completion_poll_cb(void)
     568                 :            : {
     569                 :            :         struct nvme_completion_poll_status *status;
     570                 :          4 :         struct spdk_nvme_cpl cpl;
     571                 :            : 
     572                 :          5 :         status = calloc(1, sizeof(*status));
     573         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(status != NULL);
     574                 :            : 
     575                 :          5 :         memset(&cpl, 0xff, sizeof(cpl));
     576                 :            : 
     577                 :          5 :         nvme_completion_poll_cb(status, &cpl);
     578         [ -  + ]:          5 :         CU_ASSERT(status->done == true);
     579         [ -  + ]:          5 :         CU_ASSERT(memcmp(&cpl, &status->cpl,
     580                 :            :                          sizeof(struct spdk_nvme_cpl)) == 0);
     581                 :            : 
     582                 :          5 :         free(status);
     583                 :          5 : }
     584                 :            : 
     585                 :            : /* stub callback used by test_nvme_user_copy_cmd_complete() */
     586                 :            : static struct spdk_nvme_cpl ut_spdk_nvme_cpl = {0};
     587                 :            : static void
     588                 :         15 : dummy_cb(void *user_cb_arg, const struct spdk_nvme_cpl *cpl)
     589                 :            : {
     590                 :         15 :         ut_spdk_nvme_cpl  = *cpl;
     591                 :         15 : }
     592                 :            : 
     593                 :            : static void
     594                 :          5 : test_nvme_user_copy_cmd_complete(void)
     595                 :            : {
     596                 :          4 :         struct nvme_request req;
     597                 :          5 :         int test_data = 0xdeadbeef;
     598                 :          5 :         int buff_size = sizeof(int);
     599                 :            :         void *user_buffer, *buff;
     600                 :          5 :         int user_cb_arg = 0x123;
     601                 :            :         static struct spdk_nvme_cpl cpl;
     602                 :            : 
     603                 :          5 :         memset(&req, 0, sizeof(req));
     604                 :          5 :         memset(&cpl, 0x5a, sizeof(cpl));
     605                 :            : 
     606                 :            :         /* test without a user buffer provided */
     607                 :          5 :         req.user_cb_fn = (void *)dummy_cb;
     608                 :          5 :         req.user_cb_arg = (void *)&user_cb_arg;
     609                 :          5 :         nvme_user_copy_cmd_complete(&req, &cpl);
     610                 :          5 :         CU_ASSERT(memcmp(&ut_spdk_nvme_cpl, &cpl, sizeof(cpl)) == 0);
     611                 :          5 :         CU_ASSERT(req.user_cb_fn == NULL);
     612                 :          5 :         CU_ASSERT(req.user_cb_arg == NULL);
     613                 :          5 :         CU_ASSERT(req.user_buffer == NULL);
     614                 :            : 
     615                 :            :         /* test with a user buffer provided */
     616                 :          5 :         user_buffer = malloc(buff_size);
     617                 :          5 :         req.user_cb_fn = (void *)dummy_cb;
     618                 :          5 :         req.user_cb_arg = (void *)&user_cb_arg;
     619                 :          5 :         req.user_buffer = user_buffer;
     620         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(req.user_buffer != NULL);
     621         [ -  + ]:          5 :         memset(req.user_buffer, 0, buff_size);
     622                 :          5 :         req.payload_size = buff_size;
     623                 :          5 :         buff = spdk_zmalloc(buff_size, 0x100, NULL, SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA);
     624         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(buff != NULL);
     625                 :          5 :         req.payload = NVME_PAYLOAD_CONTIG(buff, NULL);
     626         [ -  + ]:          5 :         memcpy(buff, &test_data, buff_size);
     627                 :          5 :         req.cmd.opc = SPDK_NVME_OPC_GET_LOG_PAGE;
     628                 :          5 :         req.pid = getpid();
     629                 :            : 
     630                 :            :         /* zero out the test value set in the callback */
     631                 :          5 :         memset(&ut_spdk_nvme_cpl, 0, sizeof(ut_spdk_nvme_cpl));
     632                 :            : 
     633                 :          5 :         nvme_user_copy_cmd_complete(&req, &cpl);
     634         [ -  + ]:          5 :         CU_ASSERT(memcmp(user_buffer, &test_data, buff_size) == 0);
     635                 :          5 :         CU_ASSERT(memcmp(&ut_spdk_nvme_cpl, &cpl, sizeof(cpl)) == 0);
     636                 :          5 :         CU_ASSERT(req.user_cb_fn == NULL);
     637                 :          5 :         CU_ASSERT(req.user_cb_arg == NULL);
     638                 :          5 :         CU_ASSERT(req.user_buffer == NULL);
     639                 :            : 
     640                 :            :         /*
     641                 :            :          * Now test the same path as above but this time choose an opc
     642                 :            :          * that results in a different data transfer type.
     643                 :            :          */
     644                 :          5 :         memset(&ut_spdk_nvme_cpl, 0, sizeof(ut_spdk_nvme_cpl));
     645                 :          5 :         req.user_cb_fn = (void *)dummy_cb;
     646                 :          5 :         req.user_cb_arg = (void *)&user_cb_arg;
     647                 :          5 :         req.user_buffer = user_buffer;
     648         [ -  + ]:          5 :         memset(req.user_buffer, 0, buff_size);
     649                 :          5 :         buff = spdk_zmalloc(buff_size, 0x100, NULL, SPDK_ENV_LCORE_ID_ANY, SPDK_MALLOC_DMA);
     650         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(buff != NULL);
     651                 :          5 :         req.payload = NVME_PAYLOAD_CONTIG(buff, NULL);
     652         [ -  + ]:          5 :         memcpy(buff, &test_data, buff_size);
     653                 :          5 :         req.cmd.opc = SPDK_NVME_OPC_SET_FEATURES;
     654                 :          5 :         nvme_user_copy_cmd_complete(&req, &cpl);
     655         [ -  + ]:          5 :         CU_ASSERT(memcmp(user_buffer, &test_data, buff_size) != 0);
     656                 :          5 :         CU_ASSERT(memcmp(&ut_spdk_nvme_cpl, &cpl, sizeof(cpl)) == 0);
     657                 :          5 :         CU_ASSERT(req.user_cb_fn == NULL);
     658                 :          5 :         CU_ASSERT(req.user_cb_arg == NULL);
     659                 :          5 :         CU_ASSERT(req.user_buffer == NULL);
     660                 :            : 
     661                 :            :         /* clean up */
     662                 :          5 :         free(user_buffer);
     663                 :          5 : }
     664                 :            : 
     665                 :            : static void
     666                 :          5 : test_nvme_allocate_request_null(void)
     667                 :            : {
     668                 :          5 :         struct spdk_nvme_qpair qpair = {};
     669                 :          5 :         spdk_nvme_cmd_cb cb_fn = (spdk_nvme_cmd_cb)0x1234;
     670                 :          5 :         void *cb_arg = (void *)0x5678;
     671                 :          5 :         struct nvme_request *req = NULL;
     672                 :          4 :         struct nvme_request dummy_req;
     673                 :            : 
     674                 :          5 :         STAILQ_INIT(&qpair.free_req);
     675                 :          5 :         STAILQ_INIT(&qpair.queued_req);
     676                 :            : 
     677                 :            :         /*
     678                 :            :          * Put a dummy on the queue so we can make a request
     679                 :            :          * and confirm that what comes back is what we expect.
     680                 :            :          */
     681         [ +  - ]:          5 :         STAILQ_INSERT_HEAD(&qpair.free_req, &dummy_req, stailq);
     682                 :            : 
     683                 :          5 :         req = nvme_allocate_request_null(&qpair, cb_fn, cb_arg);
     684                 :            : 
     685                 :            :         /*
     686                 :            :          * Compare the req with the parameters that we passed in
     687                 :            :          * as well as what the function is supposed to update.
     688                 :            :          */
     689         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(req != NULL);
     690                 :          5 :         CU_ASSERT(req->cb_fn == cb_fn);
     691                 :          5 :         CU_ASSERT(req->cb_arg == cb_arg);
     692                 :          5 :         CU_ASSERT(req->pid == getpid());
     693                 :          5 :         CU_ASSERT(nvme_payload_type(&req->payload) == NVME_PAYLOAD_TYPE_CONTIG);
     694                 :          5 :         CU_ASSERT(req->payload.md == NULL);
     695                 :          5 :         CU_ASSERT(req->payload.contig_or_cb_arg == NULL);
     696                 :          5 : }
     697                 :            : 
     698                 :            : static void
     699                 :          5 : test_nvme_allocate_request(void)
     700                 :            : {
     701                 :          4 :         struct spdk_nvme_qpair qpair;
     702                 :          4 :         struct nvme_payload payload;
     703                 :          5 :         uint32_t payload_struct_size = sizeof(payload);
     704                 :          5 :         spdk_nvme_cmd_cb cb_fn = (spdk_nvme_cmd_cb)0x1234;
     705                 :          5 :         void *cb_arg = (void *)0x6789;
     706                 :          5 :         struct nvme_request *req = NULL;
     707                 :          4 :         struct nvme_request dummy_req;
     708                 :            : 
     709                 :            :         /* Fill the whole payload struct with a known pattern */
     710                 :          5 :         memset(&payload, 0x5a, payload_struct_size);
     711                 :          5 :         STAILQ_INIT(&qpair.free_req);
     712                 :          5 :         STAILQ_INIT(&qpair.queued_req);
     713                 :          5 :         qpair.num_outstanding_reqs = 0;
     714                 :            : 
     715                 :            :         /* Test trying to allocate a request when no requests are available */
     716                 :          5 :         req = nvme_allocate_request(&qpair, &payload, payload_struct_size, 0,
     717                 :            :                                     cb_fn, cb_arg);
     718                 :          5 :         CU_ASSERT(req == NULL);
     719                 :          5 :         CU_ASSERT(qpair.num_outstanding_reqs == 0);
     720                 :            : 
     721                 :            :         /* put a dummy on the queue, and then allocate one */
     722         [ +  - ]:          5 :         STAILQ_INSERT_HEAD(&qpair.free_req, &dummy_req, stailq);
     723                 :          5 :         req = nvme_allocate_request(&qpair, &payload, payload_struct_size, 0,
     724                 :            :                                     cb_fn, cb_arg);
     725                 :            : 
     726                 :            :         /* all the req elements should now match the passed in parameters */
     727         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(req != NULL);
     728                 :          5 :         CU_ASSERT(qpair.num_outstanding_reqs == 1);
     729                 :          5 :         CU_ASSERT(req->cb_fn == cb_fn);
     730                 :          5 :         CU_ASSERT(req->cb_arg == cb_arg);
     731         [ -  + ]:          5 :         CU_ASSERT(memcmp(&req->payload, &payload, payload_struct_size) == 0);
     732                 :          5 :         CU_ASSERT(req->payload_size == payload_struct_size);
     733                 :          5 :         CU_ASSERT(req->pid == getpid());
     734                 :          5 : }
     735                 :            : 
     736                 :            : static void
     737                 :          5 : test_nvme_free_request(void)
     738                 :            : {
     739                 :          4 :         struct nvme_request match_req;
     740                 :          5 :         struct spdk_nvme_qpair qpair = {0};
     741                 :            :         struct nvme_request *req;
     742                 :            : 
     743                 :            :         /* put a req on the Q, take it off and compare */
     744         [ -  + ]:          5 :         memset(&match_req.cmd, 0x5a, sizeof(struct spdk_nvme_cmd));
     745                 :          5 :         match_req.qpair = &qpair;
     746                 :          5 :         qpair.num_outstanding_reqs = 1;
     747                 :            :         /* the code under tests asserts this condition */
     748                 :          5 :         match_req.num_children = 0;
     749                 :          5 :         STAILQ_INIT(&qpair.free_req);
     750                 :          5 :         match_req.qpair->reserved_req = NULL;
     751                 :            : 
     752                 :          5 :         nvme_free_request(&match_req);
     753                 :          5 :         req = STAILQ_FIRST(&match_req.qpair->free_req);
     754                 :          5 :         CU_ASSERT(req == &match_req);
     755                 :          5 :         CU_ASSERT(qpair.num_outstanding_reqs == 0);
     756                 :          5 : }
     757                 :            : 
     758                 :            : static void
     759                 :          5 : test_nvme_allocate_request_user_copy(void)
     760                 :            : {
     761                 :          4 :         struct spdk_nvme_qpair qpair;
     762                 :          5 :         spdk_nvme_cmd_cb cb_fn = (spdk_nvme_cmd_cb)0x12345;
     763                 :          5 :         void *cb_arg = (void *)0x12345;
     764                 :          5 :         bool host_to_controller = true;
     765                 :            :         struct nvme_request *req;
     766                 :          4 :         struct nvme_request dummy_req;
     767                 :          5 :         int test_data = 0xdeadbeef;
     768                 :          5 :         void *buffer = NULL;
     769                 :          5 :         uint32_t payload_size = sizeof(int);
     770                 :            : 
     771                 :          5 :         STAILQ_INIT(&qpair.free_req);
     772                 :          5 :         STAILQ_INIT(&qpair.queued_req);
     773                 :            : 
     774                 :            :         /* no buffer or valid payload size, early NULL return */
     775                 :          5 :         req = nvme_allocate_request_user_copy(&qpair, buffer, payload_size, cb_fn,
     776                 :            :                                               cb_arg, host_to_controller);
     777                 :          5 :         CU_ASSERT(req == NULL);
     778                 :            : 
     779                 :            :         /* good buffer and valid payload size */
     780                 :          5 :         buffer = malloc(payload_size);
     781         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(buffer != NULL);
     782         [ -  + ]:          5 :         memcpy(buffer, &test_data, payload_size);
     783                 :            : 
     784                 :            :         /* put a dummy on the queue */
     785         [ +  - ]:          5 :         STAILQ_INSERT_HEAD(&qpair.free_req, &dummy_req, stailq);
     786                 :            : 
     787   [ -  -  -  + ]:          5 :         MOCK_CLEAR(spdk_malloc);
     788   [ -  -  -  + ]:          5 :         MOCK_CLEAR(spdk_zmalloc);
     789                 :          5 :         req = nvme_allocate_request_user_copy(&qpair, buffer, payload_size, cb_fn,
     790                 :            :                                               cb_arg, host_to_controller);
     791         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(req != NULL);
     792                 :          5 :         CU_ASSERT(req->user_cb_fn == cb_fn);
     793                 :          5 :         CU_ASSERT(req->user_cb_arg == cb_arg);
     794                 :          5 :         CU_ASSERT(req->user_buffer == buffer);
     795                 :          5 :         CU_ASSERT(req->cb_arg == req);
     796   [ -  +  -  + ]:          5 :         CU_ASSERT(memcmp(req->payload.contig_or_cb_arg, buffer, payload_size) == 0);
     797                 :          5 :         spdk_free(req->payload.contig_or_cb_arg);
     798                 :            : 
     799                 :            :         /* same thing but additional path coverage, no copy */
     800                 :          5 :         host_to_controller = false;
     801         [ +  - ]:          5 :         STAILQ_INSERT_HEAD(&qpair.free_req, &dummy_req, stailq);
     802                 :            : 
     803                 :          5 :         req = nvme_allocate_request_user_copy(&qpair, buffer, payload_size, cb_fn,
     804                 :            :                                               cb_arg, host_to_controller);
     805         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(req != NULL);
     806                 :          5 :         CU_ASSERT(req->user_cb_fn == cb_fn);
     807                 :          5 :         CU_ASSERT(req->user_cb_arg == cb_arg);
     808                 :          5 :         CU_ASSERT(req->user_buffer == buffer);
     809                 :          5 :         CU_ASSERT(req->cb_arg == req);
     810   [ -  +  -  + ]:          5 :         CU_ASSERT(memcmp(req->payload.contig_or_cb_arg, buffer, payload_size) != 0);
     811                 :          5 :         spdk_free(req->payload.contig_or_cb_arg);
     812                 :            : 
     813                 :            :         /* good buffer and valid payload size but make spdk_zmalloc fail */
     814                 :            :         /* set the mock pointer to NULL for spdk_zmalloc */
     815                 :          5 :         MOCK_SET(spdk_zmalloc, NULL);
     816                 :          5 :         req = nvme_allocate_request_user_copy(&qpair, buffer, payload_size, cb_fn,
     817                 :            :                                               cb_arg, host_to_controller);
     818                 :          5 :         CU_ASSERT(req == NULL);
     819                 :          5 :         free(buffer);
     820   [ -  -  -  + ]:          5 :         MOCK_CLEAR(spdk_zmalloc);
     821                 :          5 : }
     822                 :            : 
     823                 :            : static void
     824                 :          5 : test_nvme_ctrlr_probe(void)
     825                 :            : {
     826                 :          5 :         int rc = 0;
     827                 :          5 :         struct spdk_nvme_ctrlr ctrlr = {};
     828                 :          5 :         struct spdk_nvme_qpair qpair = {};
     829                 :          5 :         const struct spdk_nvme_transport_id trid = {};
     830                 :          5 :         struct spdk_nvme_probe_ctx probe_ctx = {};
     831                 :          5 :         void *devhandle = NULL;
     832                 :          5 :         void *cb_ctx = NULL;
     833                 :          5 :         struct spdk_nvme_ctrlr *dummy = NULL;
     834                 :            : 
     835                 :          5 :         ctrlr.adminq = &qpair;
     836                 :            : 
     837                 :          5 :         TAILQ_INIT(&probe_ctx.init_ctrlrs);
     838                 :          5 :         nvme_driver_init();
     839                 :            : 
     840                 :            :         /* test when probe_cb returns false */
     841                 :            : 
     842                 :          5 :         MOCK_SET(dummy_probe_cb, false);
     843                 :          5 :         nvme_probe_ctx_init(&probe_ctx, &trid, NULL, cb_ctx, dummy_probe_cb, NULL, NULL);
     844                 :          5 :         rc = nvme_ctrlr_probe(&trid, &probe_ctx, devhandle);
     845                 :          5 :         CU_ASSERT(rc == 1);
     846                 :            : 
     847                 :            :         /* probe_cb returns true but we can't construct a ctrl */
     848                 :          5 :         MOCK_SET(dummy_probe_cb, true);
     849                 :          5 :         MOCK_SET(nvme_transport_ctrlr_construct, NULL);
     850                 :          5 :         nvme_probe_ctx_init(&probe_ctx, &trid, NULL, cb_ctx, dummy_probe_cb, NULL, NULL);
     851                 :          5 :         rc = nvme_ctrlr_probe(&trid, &probe_ctx, devhandle);
     852                 :          5 :         CU_ASSERT(rc == -1);
     853                 :            : 
     854                 :            :         /* happy path */
     855                 :          5 :         MOCK_SET(dummy_probe_cb, true);
     856                 :          5 :         MOCK_SET(nvme_transport_ctrlr_construct, &ctrlr);
     857                 :          5 :         nvme_probe_ctx_init(&probe_ctx, &trid, NULL, cb_ctx, dummy_probe_cb, NULL, NULL);
     858                 :          5 :         rc = nvme_ctrlr_probe(&trid, &probe_ctx, devhandle);
     859                 :          5 :         CU_ASSERT(rc == 0);
     860                 :          5 :         dummy = TAILQ_FIRST(&probe_ctx.init_ctrlrs);
     861         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(dummy != NULL);
     862                 :          5 :         CU_ASSERT(dummy == ut_nvme_transport_ctrlr_construct);
     863         [ -  + ]:          5 :         TAILQ_REMOVE(&probe_ctx.init_ctrlrs, dummy, tailq);
     864   [ -  -  -  + ]:          5 :         MOCK_CLEAR_P(nvme_transport_ctrlr_construct);
     865                 :            : 
     866                 :          5 :         free(g_spdk_nvme_driver);
     867                 :          5 : }
     868                 :            : 
     869                 :            : static void
     870                 :          5 : test_nvme_robust_mutex_init_shared(void)
     871                 :            : {
     872                 :          4 :         pthread_mutex_t mtx;
     873                 :          5 :         int rc = 0;
     874                 :            : 
     875                 :            :         /* test where both pthread calls succeed */
     876                 :          5 :         MOCK_SET(pthread_mutexattr_init, 0);
     877                 :          5 :         MOCK_SET(pthread_mutex_init, 0);
     878                 :          5 :         rc = nvme_robust_mutex_init_shared(&mtx);
     879                 :          5 :         CU_ASSERT(rc == 0);
     880                 :            : 
     881                 :            :         /* test where we can't init attr's but init mutex works */
     882                 :          5 :         MOCK_SET(pthread_mutexattr_init, -1);
     883                 :          5 :         MOCK_SET(pthread_mutex_init, 0);
     884                 :          5 :         rc = nvme_robust_mutex_init_shared(&mtx);
     885                 :            :         /* for FreeBSD the only possible return value is 0 */
     886                 :            : #ifndef __FreeBSD__
     887                 :          5 :         CU_ASSERT(rc != 0);
     888                 :            : #else
     889                 :            :         CU_ASSERT(rc == 0);
     890                 :            : #endif
     891                 :            : 
     892                 :            :         /* test where we can init attr's but the mutex init fails */
     893                 :          5 :         MOCK_SET(pthread_mutexattr_init, 0);
     894                 :          5 :         MOCK_SET(pthread_mutex_init, -1);
     895                 :          5 :         rc = nvme_robust_mutex_init_shared(&mtx);
     896                 :            :         /* for FreeBSD the only possible return value is 0 */
     897                 :            : #ifndef __FreeBSD__
     898                 :          5 :         CU_ASSERT(rc != 0);
     899                 :            : #else
     900                 :            :         CU_ASSERT(rc == 0);
     901                 :            : #endif
     902   [ -  -  -  + ]:          5 :         MOCK_CLEAR(pthread_mutex_init);
     903                 :          5 : }
     904                 :            : 
     905                 :            : static void
     906                 :          5 : test_opc_data_transfer(void)
     907                 :            : {
     908                 :            :         enum spdk_nvme_data_transfer xfer;
     909                 :            : 
     910                 :          5 :         xfer = spdk_nvme_opc_get_data_transfer(SPDK_NVME_OPC_FLUSH);
     911                 :          5 :         CU_ASSERT(xfer == SPDK_NVME_DATA_NONE);
     912                 :            : 
     913                 :          5 :         xfer = spdk_nvme_opc_get_data_transfer(SPDK_NVME_OPC_WRITE);
     914                 :          5 :         CU_ASSERT(xfer == SPDK_NVME_DATA_HOST_TO_CONTROLLER);
     915                 :            : 
     916                 :          5 :         xfer = spdk_nvme_opc_get_data_transfer(SPDK_NVME_OPC_READ);
     917                 :          5 :         CU_ASSERT(xfer == SPDK_NVME_DATA_CONTROLLER_TO_HOST);
     918                 :            : 
     919                 :          5 :         xfer = spdk_nvme_opc_get_data_transfer(SPDK_NVME_OPC_GET_LOG_PAGE);
     920                 :          5 :         CU_ASSERT(xfer == SPDK_NVME_DATA_CONTROLLER_TO_HOST);
     921                 :          5 : }
     922                 :            : 
     923                 :            : static void
     924                 :          5 : test_trid_parse_and_compare(void)
     925                 :            : {
     926                 :          4 :         struct spdk_nvme_transport_id trid1, trid2;
     927                 :            :         int ret;
     928                 :            : 
     929                 :            :         /* set trid1 trid2 value to id parse */
     930                 :          5 :         ret = spdk_nvme_transport_id_parse(NULL, "trtype:PCIe traddr:0000:04:00.0");
     931                 :          5 :         CU_ASSERT(ret == -EINVAL);
     932                 :          5 :         memset(&trid1, 0, sizeof(trid1));
     933                 :          5 :         ret = spdk_nvme_transport_id_parse(&trid1, NULL);
     934                 :          5 :         CU_ASSERT(ret == -EINVAL);
     935                 :          5 :         ret = spdk_nvme_transport_id_parse(NULL, NULL);
     936                 :          5 :         CU_ASSERT(ret == -EINVAL);
     937                 :          5 :         memset(&trid1, 0, sizeof(trid1));
     938                 :          5 :         ret = spdk_nvme_transport_id_parse(&trid1, "trtype-PCIe traddr-0000-04-00.0");
     939                 :          5 :         CU_ASSERT(ret == -EINVAL);
     940                 :          5 :         memset(&trid1, 0, sizeof(trid1));
     941                 :          5 :         ret = spdk_nvme_transport_id_parse(&trid1, "trtype-PCIe traddr-0000-04-00.0-:");
     942                 :          5 :         CU_ASSERT(ret == -EINVAL);
     943                 :          5 :         memset(&trid1, 0, sizeof(trid1));
     944                 :          5 :         ret = spdk_nvme_transport_id_parse(&trid1, " \t\n:");
     945                 :          5 :         CU_ASSERT(ret == -EINVAL);
     946                 :          5 :         memset(&trid1, 0, sizeof(trid1));
     947                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid1,
     948                 :            :                                                "trtype:rdma\n"
     949                 :            :                                                "adrfam:ipv4\n"
     950                 :            :                                                "traddr:192.168.100.8\n"
     951                 :            :                                                "trsvcid:4420\n"
     952                 :            :                                                "subnqn:nqn.2014-08.org.nvmexpress.discovery") == 0);
     953                 :          5 :         CU_ASSERT(trid1.trtype == SPDK_NVME_TRANSPORT_RDMA);
     954                 :          5 :         CU_ASSERT(trid1.adrfam == SPDK_NVMF_ADRFAM_IPV4);
     955                 :          5 :         CU_ASSERT(strcmp(trid1.traddr, "192.168.100.8") == 0);
     956                 :          5 :         CU_ASSERT(strcmp(trid1.trsvcid, "4420") == 0);
     957                 :          5 :         CU_ASSERT(strcmp(trid1.subnqn, "nqn.2014-08.org.nvmexpress.discovery") == 0);
     958                 :            : 
     959                 :          5 :         memset(&trid2, 0, sizeof(trid2));
     960                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid2, "trtype:PCIe traddr:0000:04:00.0") == 0);
     961                 :          5 :         CU_ASSERT(trid2.trtype == SPDK_NVME_TRANSPORT_PCIE);
     962                 :          5 :         CU_ASSERT(strcmp(trid2.traddr, "0000:04:00.0") == 0);
     963                 :            : 
     964                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_compare(&trid1, &trid2) != 0);
     965                 :            : 
     966                 :            :         /* set trid1 trid2 and test id_compare */
     967                 :          5 :         memset_trid(&trid1, &trid2);
     968                 :          5 :         trid1.adrfam = SPDK_NVMF_ADRFAM_IPV6;
     969                 :          5 :         trid2.adrfam = SPDK_NVMF_ADRFAM_IPV4;
     970                 :          5 :         ret = spdk_nvme_transport_id_compare(&trid1, &trid2);
     971                 :          5 :         CU_ASSERT(ret > 0);
     972                 :            : 
     973                 :          5 :         memset_trid(&trid1, &trid2);
     974                 :          5 :         snprintf(trid1.traddr, sizeof(trid1.traddr), "192.168.100.8");
     975                 :          5 :         snprintf(trid2.traddr, sizeof(trid2.traddr), "192.168.100.9");
     976                 :          5 :         ret = spdk_nvme_transport_id_compare(&trid1, &trid2);
     977                 :          5 :         CU_ASSERT(ret < 0);
     978                 :            : 
     979                 :          5 :         memset_trid(&trid1, &trid2);
     980                 :          5 :         snprintf(trid1.trsvcid, sizeof(trid1.trsvcid), "4420");
     981                 :          5 :         snprintf(trid2.trsvcid, sizeof(trid2.trsvcid), "4421");
     982                 :          5 :         ret = spdk_nvme_transport_id_compare(&trid1, &trid2);
     983                 :          5 :         CU_ASSERT(ret < 0);
     984                 :            : 
     985                 :          5 :         memset_trid(&trid1, &trid2);
     986                 :          5 :         snprintf(trid1.subnqn, sizeof(trid1.subnqn), "subnqn:nqn.2016-08.org.nvmexpress.discovery");
     987                 :          5 :         snprintf(trid2.subnqn, sizeof(trid2.subnqn), "subnqn:nqn.2017-08.org.nvmexpress.discovery");
     988                 :          5 :         ret = spdk_nvme_transport_id_compare(&trid1, &trid2);
     989                 :          5 :         CU_ASSERT(ret < 0);
     990                 :            : 
     991                 :          5 :         memset_trid(&trid1, &trid2);
     992                 :          5 :         snprintf(trid1.subnqn, sizeof(trid1.subnqn), "subnqn:nqn.2016-08.org.nvmexpress.discovery");
     993                 :          5 :         snprintf(trid2.subnqn, sizeof(trid2.subnqn), "subnqn:nqn.2016-08.org.nvmexpress.discovery");
     994                 :          5 :         ret = spdk_nvme_transport_id_compare(&trid1, &trid2);
     995                 :          5 :         CU_ASSERT(ret == 0);
     996                 :            : 
     997                 :          5 :         memset_trid(&trid1, &trid2);
     998                 :          5 :         snprintf(trid1.subnqn, sizeof(trid1.subnqn), "subnqn:nqn.2016-08.org.nvmexpress.discovery");
     999                 :          5 :         snprintf(trid2.subnqn, sizeof(trid2.subnqn), "subnqn:nqn.2016-08.org.Nvmexpress.discovery");
    1000                 :          5 :         ret = spdk_nvme_transport_id_compare(&trid1, &trid2);
    1001                 :          5 :         CU_ASSERT(ret > 0);
    1002                 :            : 
    1003                 :          5 :         memset_trid(&trid1, &trid2);
    1004                 :          5 :         ret = spdk_nvme_transport_id_compare(&trid1, &trid2);
    1005                 :          5 :         CU_ASSERT(ret == 0);
    1006                 :            : 
    1007                 :            :         /* Compare PCI addresses via spdk_pci_addr_compare (rather than as strings) */
    1008                 :          5 :         memset_trid(&trid1, &trid2);
    1009                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid1, "trtype:PCIe traddr:0000:04:00.0") == 0);
    1010                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid2, "trtype:PCIe traddr:04:00.0") == 0);
    1011                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_compare(&trid1, &trid2) == 0);
    1012                 :            : 
    1013                 :          5 :         memset_trid(&trid1, &trid2);
    1014                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid1, "trtype:PCIe traddr:0000:05:00.0") == 0);
    1015                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid2, "trtype:PCIe traddr:04:00.0") == 0);
    1016                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_compare(&trid1, &trid2) > 0);
    1017                 :            : 
    1018                 :          5 :         memset_trid(&trid1, &trid2);
    1019                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid1, "trtype:PCIe traddr:0000:04:00.0") == 0);
    1020                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid2, "trtype:PCIe traddr:05:00.0") == 0);
    1021                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_compare(&trid1, &trid2) < 0);
    1022                 :            : 
    1023                 :          5 :         memset_trid(&trid1, &trid2);
    1024                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid1, "trtype=PCIe traddr=0000:04:00.0") == 0);
    1025                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid2, "trtype=PCIe traddr=05:00.0") == 0);
    1026                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_compare(&trid1, &trid2) < 0);
    1027                 :            : 
    1028                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse(&trid1,
    1029                 :            :                                                "trtype:tcp\n"
    1030                 :            :                                                "adrfam:ipv4\n"
    1031                 :            :                                                "traddr:192.168.100.8\n"
    1032                 :            :                                                "trsvcid:4420\n"
    1033                 :            :                                                "priority:2\n"
    1034                 :            :                                                "subnqn:nqn.2014-08.org.nvmexpress.discovery") == 0);
    1035                 :          5 :         CU_ASSERT(trid1.priority == 2);
    1036                 :          5 : }
    1037                 :            : 
    1038                 :            : static void
    1039                 :          5 : test_spdk_nvme_transport_id_parse_trtype(void)
    1040                 :            : {
    1041                 :            : 
    1042                 :            :         enum spdk_nvme_transport_type *trtype;
    1043                 :          4 :         enum spdk_nvme_transport_type sct;
    1044                 :            :         char *str;
    1045                 :            : 
    1046                 :          5 :         trtype = NULL;
    1047                 :          5 :         str = "unit_test";
    1048                 :            : 
    1049                 :            :         /* test function returned value when trtype is NULL but str not NULL */
    1050                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse_trtype(trtype, str) == (-EINVAL));
    1051                 :            : 
    1052                 :            :         /* test function returned value when str is NULL but trtype not NULL */
    1053                 :          5 :         trtype = &sct;
    1054                 :          5 :         str = NULL;
    1055                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse_trtype(trtype, str) == (-EINVAL));
    1056                 :            : 
    1057                 :            :         /* test function returned value when str and strtype not NULL, but str value
    1058                 :            :          * not "PCIe" or "RDMA" */
    1059                 :          5 :         str = "unit_test";
    1060                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse_trtype(trtype, str) == 0);
    1061                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_CUSTOM);
    1062                 :            : 
    1063                 :            :         /* test trtype value when use function "strcasecmp" to compare str and "PCIe",not case-sensitive */
    1064                 :          5 :         str = "PCIe";
    1065                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1066                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_PCIE);
    1067                 :            : 
    1068                 :          5 :         str = "pciE";
    1069                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1070                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_PCIE);
    1071                 :            : 
    1072                 :            :         /* test trtype value when use function "strcasecmp" to compare str and "RDMA",not case-sensitive */
    1073                 :          5 :         str = "RDMA";
    1074                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1075                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_RDMA);
    1076                 :            : 
    1077                 :          5 :         str = "rdma";
    1078                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1079                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_RDMA);
    1080                 :            : 
    1081                 :            :         /* test trtype value when use function "strcasecmp" to compare str and "FC",not case-sensitive */
    1082                 :          5 :         str = "FC";
    1083                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1084                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_FC);
    1085                 :            : 
    1086                 :          5 :         str = "fc";
    1087                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1088                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_FC);
    1089                 :            : 
    1090                 :            :         /* test trtype value when use function "strcasecmp" to compare str and "TCP",not case-sensitive */
    1091                 :          5 :         str = "TCP";
    1092                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1093                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_TCP);
    1094                 :            : 
    1095                 :          5 :         str = "tcp";
    1096                 :          5 :         spdk_nvme_transport_id_parse_trtype(trtype, str);
    1097                 :          5 :         CU_ASSERT((*trtype) == SPDK_NVME_TRANSPORT_TCP);
    1098                 :          5 : }
    1099                 :            : 
    1100                 :            : static void
    1101                 :          5 : test_spdk_nvme_transport_id_parse_adrfam(void)
    1102                 :            : {
    1103                 :            : 
    1104                 :            :         enum spdk_nvmf_adrfam *adrfam;
    1105                 :          4 :         enum spdk_nvmf_adrfam sct;
    1106                 :            :         char *str;
    1107                 :            : 
    1108                 :          5 :         adrfam = NULL;
    1109                 :          5 :         str = "unit_test";
    1110                 :            : 
    1111                 :            :         /* test function returned value when adrfam is NULL but str not NULL */
    1112                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse_adrfam(adrfam, str) == (-EINVAL));
    1113                 :            : 
    1114                 :            :         /* test function returned value when str is NULL but adrfam not NULL */
    1115                 :          5 :         adrfam = &sct;
    1116                 :          5 :         str = NULL;
    1117                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse_adrfam(adrfam, str) == (-EINVAL));
    1118                 :            : 
    1119                 :            :         /* test function returned value when str and adrfam not NULL, but str value
    1120                 :            :          * not "IPv4" or "IPv6" or "IB" or "FC" */
    1121                 :          5 :         str = "unit_test";
    1122                 :          5 :         CU_ASSERT(spdk_nvme_transport_id_parse_adrfam(adrfam, str) == (-ENOENT));
    1123                 :            : 
    1124                 :            :         /* test adrfam value when use function "strcasecmp" to compare str and "IPv4",not case-sensitive */
    1125                 :          5 :         str = "IPv4";
    1126                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1127                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_IPV4);
    1128                 :            : 
    1129                 :          5 :         str = "ipV4";
    1130                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1131                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_IPV4);
    1132                 :            : 
    1133                 :            :         /* test adrfam value when use function "strcasecmp" to compare str and "IPv6",not case-sensitive */
    1134                 :          5 :         str = "IPv6";
    1135                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1136                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_IPV6);
    1137                 :            : 
    1138                 :          5 :         str = "ipV6";
    1139                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1140                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_IPV6);
    1141                 :            : 
    1142                 :            :         /* test adrfam value when use function "strcasecmp" to compare str and "IB",not case-sensitive */
    1143                 :          5 :         str = "IB";
    1144                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1145                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_IB);
    1146                 :            : 
    1147                 :          5 :         str = "ib";
    1148                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1149                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_IB);
    1150                 :            : 
    1151                 :            :         /* test adrfam value when use function "strcasecmp" to compare str and "FC",not case-sensitive */
    1152                 :          5 :         str = "FC";
    1153                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1154                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_FC);
    1155                 :            : 
    1156                 :          5 :         str = "fc";
    1157                 :          5 :         spdk_nvme_transport_id_parse_adrfam(adrfam, str);
    1158                 :          5 :         CU_ASSERT((*adrfam) == SPDK_NVMF_ADRFAM_FC);
    1159                 :            : 
    1160                 :          5 : }
    1161                 :            : 
    1162                 :            : static void
    1163                 :          5 : test_trid_trtype_str(void)
    1164                 :            : {
    1165                 :            :         const char *s;
    1166                 :            : 
    1167                 :          5 :         s = spdk_nvme_transport_id_trtype_str(-5);
    1168                 :          5 :         CU_ASSERT(s == NULL);
    1169                 :            : 
    1170                 :          5 :         s = spdk_nvme_transport_id_trtype_str(SPDK_NVME_TRANSPORT_PCIE);
    1171         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1172         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "PCIe") == 0);
    1173                 :            : 
    1174                 :          5 :         s = spdk_nvme_transport_id_trtype_str(SPDK_NVME_TRANSPORT_RDMA);
    1175         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1176         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "RDMA") == 0);
    1177                 :            : 
    1178                 :          5 :         s = spdk_nvme_transport_id_trtype_str(SPDK_NVME_TRANSPORT_FC);
    1179         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1180         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "FC") == 0);
    1181                 :            : 
    1182                 :          5 :         s = spdk_nvme_transport_id_trtype_str(SPDK_NVME_TRANSPORT_TCP);
    1183         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1184         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "TCP") == 0);
    1185                 :          5 : }
    1186                 :            : 
    1187                 :            : static void
    1188                 :          5 : test_trid_adrfam_str(void)
    1189                 :            : {
    1190                 :            :         const char *s;
    1191                 :            : 
    1192                 :          5 :         s = spdk_nvme_transport_id_adrfam_str(-5);
    1193                 :          5 :         CU_ASSERT(s == NULL);
    1194                 :            : 
    1195                 :          5 :         s = spdk_nvme_transport_id_adrfam_str(SPDK_NVMF_ADRFAM_IPV4);
    1196         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1197         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "IPv4") == 0);
    1198                 :            : 
    1199                 :          5 :         s = spdk_nvme_transport_id_adrfam_str(SPDK_NVMF_ADRFAM_IPV6);
    1200         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1201         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "IPv6") == 0);
    1202                 :            : 
    1203                 :          5 :         s = spdk_nvme_transport_id_adrfam_str(SPDK_NVMF_ADRFAM_IB);
    1204         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1205         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "IB") == 0);
    1206                 :            : 
    1207                 :          5 :         s = spdk_nvme_transport_id_adrfam_str(SPDK_NVMF_ADRFAM_FC);
    1208         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(s != NULL);
    1209         [ -  + ]:          5 :         CU_ASSERT(strcmp(s, "FC") == 0);
    1210                 :          5 : }
    1211                 :            : 
    1212                 :            : /* stub callback used by the test_nvme_request_check_timeout */
    1213                 :            : static bool ut_timeout_cb_call = false;
    1214                 :            : static void
    1215                 :          5 : dummy_timeout_cb(void *cb_arg, struct spdk_nvme_ctrlr *ctrlr,
    1216                 :            :                  struct spdk_nvme_qpair *qpair, uint16_t cid)
    1217                 :            : {
    1218                 :          5 :         ut_timeout_cb_call = true;
    1219                 :          5 : }
    1220                 :            : 
    1221                 :            : static void
    1222                 :          5 : test_nvme_request_check_timeout(void)
    1223                 :            : {
    1224                 :            :         int rc;
    1225                 :          4 :         struct spdk_nvme_qpair qpair;
    1226                 :          4 :         struct nvme_request req;
    1227                 :          4 :         struct spdk_nvme_ctrlr_process active_proc;
    1228                 :          5 :         uint16_t cid = 0;
    1229                 :          5 :         uint64_t now_tick = 0;
    1230                 :            : 
    1231         [ -  + ]:          5 :         memset(&qpair, 0x0, sizeof(qpair));
    1232         [ -  + ]:          5 :         memset(&req, 0x0, sizeof(req));
    1233         [ -  + ]:          5 :         memset(&active_proc, 0x0, sizeof(active_proc));
    1234                 :          5 :         req.qpair = &qpair;
    1235                 :          5 :         active_proc.timeout_cb_fn = dummy_timeout_cb;
    1236                 :            : 
    1237                 :            :         /* if have called timeout_cb_fn then return directly */
    1238                 :          5 :         req.timed_out = true;
    1239                 :          5 :         rc = nvme_request_check_timeout(&req, cid, &active_proc, now_tick);
    1240                 :          5 :         CU_ASSERT(rc == 0);
    1241         [ -  + ]:          5 :         CU_ASSERT(ut_timeout_cb_call == false);
    1242                 :            : 
    1243                 :            :         /* if timeout isn't enabled then return directly */
    1244                 :          5 :         req.timed_out = false;
    1245                 :          5 :         req.submit_tick = 0;
    1246                 :          5 :         rc = nvme_request_check_timeout(&req, cid, &active_proc, now_tick);
    1247                 :          5 :         CU_ASSERT(rc == 0);
    1248         [ -  + ]:          5 :         CU_ASSERT(ut_timeout_cb_call == false);
    1249                 :            : 
    1250                 :            :         /* req->pid isn't right then return directly */
    1251                 :          5 :         req.submit_tick = 1;
    1252                 :          5 :         req.pid = g_spdk_nvme_pid + 1;
    1253                 :          5 :         rc = nvme_request_check_timeout(&req, cid, &active_proc, now_tick);
    1254                 :          5 :         CU_ASSERT(rc == 0);
    1255         [ -  + ]:          5 :         CU_ASSERT(ut_timeout_cb_call == false);
    1256                 :            : 
    1257                 :            :         /* AER command has no timeout */
    1258                 :          5 :         req.pid = g_spdk_nvme_pid;
    1259                 :          5 :         req.cmd.opc = SPDK_NVME_OPC_ASYNC_EVENT_REQUEST;
    1260                 :          5 :         rc = nvme_request_check_timeout(&req, cid, &active_proc, now_tick);
    1261                 :          5 :         CU_ASSERT(rc == 0);
    1262         [ -  + ]:          5 :         CU_ASSERT(ut_timeout_cb_call == false);
    1263                 :            : 
    1264                 :            :         /* time isn't out */
    1265                 :          5 :         qpair.id = 1;
    1266                 :          5 :         rc = nvme_request_check_timeout(&req, cid, &active_proc, now_tick);
    1267                 :          5 :         CU_ASSERT(rc == 1);
    1268         [ -  + ]:          5 :         CU_ASSERT(ut_timeout_cb_call == false);
    1269                 :            : 
    1270                 :          5 :         now_tick = 2;
    1271                 :          5 :         rc = nvme_request_check_timeout(&req, cid, &active_proc, now_tick);
    1272                 :          5 :         CU_ASSERT(req.timed_out == true);
    1273         [ -  + ]:          5 :         CU_ASSERT(ut_timeout_cb_call == true);
    1274                 :          5 :         CU_ASSERT(rc == 0);
    1275                 :          5 : }
    1276                 :            : 
    1277                 :            : struct nvme_completion_poll_status g_status;
    1278                 :            : uint64_t completion_delay_us, timeout_in_usecs;
    1279                 :            : int g_process_comp_result;
    1280                 :            : pthread_mutex_t g_robust_lock = PTHREAD_MUTEX_INITIALIZER;
    1281                 :            : 
    1282                 :            : int
    1283                 :         50 : spdk_nvme_qpair_process_completions(struct spdk_nvme_qpair *qpair, uint32_t max_completions)
    1284                 :            : {
    1285                 :         50 :         spdk_delay_us(completion_delay_us);
    1286                 :            : 
    1287   [ +  +  +  + ]:         50 :         g_status.done = completion_delay_us < timeout_in_usecs && g_process_comp_result == 0 ? true : false;
    1288                 :            : 
    1289                 :         50 :         return g_process_comp_result;
    1290                 :            : }
    1291                 :            : 
    1292                 :            : static void
    1293                 :          5 : test_nvme_wait_for_completion(void)
    1294                 :            : {
    1295                 :          4 :         struct spdk_nvme_qpair qpair;
    1296                 :          4 :         struct spdk_nvme_ctrlr ctrlr;
    1297                 :          5 :         int rc = 0;
    1298                 :            : 
    1299         [ -  + ]:          5 :         memset(&ctrlr, 0, sizeof(ctrlr));
    1300                 :          5 :         ctrlr.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
    1301         [ -  + ]:          5 :         memset(&qpair, 0, sizeof(qpair));
    1302                 :          5 :         qpair.ctrlr = &ctrlr;
    1303                 :            : 
    1304                 :            :         /* completion timeout */
    1305         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1306                 :          5 :         completion_delay_us = 2000000;
    1307                 :          5 :         timeout_in_usecs = 1000000;
    1308                 :          5 :         rc = nvme_wait_for_completion_timeout(&qpair, &g_status, timeout_in_usecs);
    1309         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == true);
    1310         [ -  + ]:          5 :         CU_ASSERT(g_status.done == false);
    1311                 :          5 :         CU_ASSERT(rc == -ECANCELED);
    1312                 :            : 
    1313                 :            :         /* spdk_nvme_qpair_process_completions returns error */
    1314         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1315                 :          5 :         g_process_comp_result = -1;
    1316                 :          5 :         completion_delay_us = 1000000;
    1317                 :          5 :         timeout_in_usecs = 2000000;
    1318                 :          5 :         rc = nvme_wait_for_completion_timeout(&qpair, &g_status, timeout_in_usecs);
    1319                 :          5 :         CU_ASSERT(rc == -ECANCELED);
    1320         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == true);
    1321         [ -  + ]:          5 :         CU_ASSERT(g_status.done == false);
    1322                 :          5 :         CU_ASSERT(g_status.cpl.status.sct == SPDK_NVME_SCT_GENERIC);
    1323                 :          5 :         CU_ASSERT(g_status.cpl.status.sc == SPDK_NVME_SC_ABORTED_SQ_DELETION);
    1324                 :            : 
    1325                 :          5 :         g_process_comp_result = 0;
    1326                 :            : 
    1327                 :            :         /* complete in time */
    1328         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1329                 :          5 :         completion_delay_us = 1000000;
    1330                 :          5 :         timeout_in_usecs = 2000000;
    1331                 :          5 :         rc = nvme_wait_for_completion_timeout(&qpair, &g_status, timeout_in_usecs);
    1332         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == false);
    1333         [ -  + ]:          5 :         CU_ASSERT(g_status.done == true);
    1334                 :          5 :         CU_ASSERT(rc == 0);
    1335                 :            : 
    1336                 :            :         /* nvme_wait_for_completion */
    1337                 :            :         /* spdk_nvme_qpair_process_completions returns error */
    1338         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1339                 :          5 :         g_process_comp_result = -1;
    1340                 :          5 :         rc = nvme_wait_for_completion(&qpair, &g_status);
    1341                 :          5 :         CU_ASSERT(rc == -ECANCELED);
    1342         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == true);
    1343         [ -  + ]:          5 :         CU_ASSERT(g_status.done == false);
    1344                 :          5 :         CU_ASSERT(g_status.cpl.status.sct == SPDK_NVME_SCT_GENERIC);
    1345                 :          5 :         CU_ASSERT(g_status.cpl.status.sc == SPDK_NVME_SC_ABORTED_SQ_DELETION);
    1346                 :            : 
    1347                 :            :         /* successful completion */
    1348         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1349                 :          5 :         g_process_comp_result = 0;
    1350                 :          5 :         rc = nvme_wait_for_completion(&qpair, &g_status);
    1351                 :          5 :         CU_ASSERT(rc == 0);
    1352         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == false);
    1353         [ -  + ]:          5 :         CU_ASSERT(g_status.done == true);
    1354                 :            : 
    1355                 :            :         /* completion  timeout */
    1356         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1357                 :          5 :         completion_delay_us = 2000000;
    1358                 :          5 :         timeout_in_usecs = 1000000;
    1359                 :          5 :         rc = nvme_wait_for_completion_robust_lock_timeout(&qpair, &g_status, &g_robust_lock,
    1360                 :            :                         timeout_in_usecs);
    1361         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == true);
    1362         [ -  + ]:          5 :         CU_ASSERT(g_status.done == false);
    1363                 :          5 :         CU_ASSERT(rc == -ECANCELED);
    1364                 :            : 
    1365                 :            :         /* spdk_nvme_qpair_process_completions returns error */
    1366         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1367                 :          5 :         g_process_comp_result = -1;
    1368                 :          5 :         completion_delay_us = 1000000;
    1369                 :          5 :         timeout_in_usecs = 2000000;
    1370                 :          5 :         rc = nvme_wait_for_completion_robust_lock_timeout(&qpair, &g_status, &g_robust_lock,
    1371                 :            :                         timeout_in_usecs);
    1372                 :          5 :         CU_ASSERT(rc == -ECANCELED);
    1373         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == true);
    1374         [ -  + ]:          5 :         CU_ASSERT(g_status.done == false);
    1375                 :          5 :         CU_ASSERT(g_status.cpl.status.sct == SPDK_NVME_SCT_GENERIC);
    1376                 :          5 :         CU_ASSERT(g_status.cpl.status.sc == SPDK_NVME_SC_ABORTED_SQ_DELETION);
    1377                 :            : 
    1378                 :          5 :         g_process_comp_result = 0;
    1379                 :            : 
    1380                 :            :         /* complete in time */
    1381         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1382                 :          5 :         completion_delay_us = 1000000;
    1383                 :          5 :         timeout_in_usecs = 2000000;
    1384                 :          5 :         rc = nvme_wait_for_completion_robust_lock_timeout(&qpair, &g_status, &g_robust_lock,
    1385                 :            :                         timeout_in_usecs);
    1386         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == false);
    1387         [ -  + ]:          5 :         CU_ASSERT(g_status.done == true);
    1388                 :          5 :         CU_ASSERT(rc == 0);
    1389                 :            : 
    1390                 :            :         /* nvme_wait_for_completion */
    1391                 :            :         /* spdk_nvme_qpair_process_completions returns error */
    1392         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1393                 :          5 :         g_process_comp_result = -1;
    1394                 :          5 :         rc = nvme_wait_for_completion_robust_lock(&qpair, &g_status, &g_robust_lock);
    1395                 :          5 :         CU_ASSERT(rc == -ECANCELED);
    1396         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == true);
    1397         [ -  + ]:          5 :         CU_ASSERT(g_status.done == false);
    1398                 :          5 :         CU_ASSERT(g_status.cpl.status.sct == SPDK_NVME_SCT_GENERIC);
    1399                 :          5 :         CU_ASSERT(g_status.cpl.status.sc == SPDK_NVME_SC_ABORTED_SQ_DELETION);
    1400                 :            : 
    1401                 :            :         /* successful completion */
    1402         [ -  + ]:          5 :         memset(&g_status, 0, sizeof(g_status));
    1403                 :          5 :         g_process_comp_result = 0;
    1404                 :          5 :         rc = nvme_wait_for_completion_robust_lock(&qpair, &g_status, &g_robust_lock);
    1405                 :          5 :         CU_ASSERT(rc == 0);
    1406         [ -  + ]:          5 :         CU_ASSERT(g_status.timed_out == false);
    1407         [ -  + ]:          5 :         CU_ASSERT(g_status.done == true);
    1408                 :          5 : }
    1409                 :            : 
    1410                 :            : static void
    1411                 :          5 : test_nvme_ctrlr_probe_internal(void)
    1412                 :            : {
    1413                 :            :         struct spdk_nvme_probe_ctx *probe_ctx;
    1414                 :          5 :         struct spdk_nvme_transport_id trid = {};
    1415                 :          5 :         struct nvme_driver dummy = {};
    1416                 :            :         int rc;
    1417                 :            : 
    1418                 :          5 :         probe_ctx = calloc(1, sizeof(*probe_ctx));
    1419                 :          5 :         CU_ASSERT(probe_ctx != NULL);
    1420                 :            : 
    1421                 :          5 :         MOCK_SET(spdk_process_is_primary, true);
    1422                 :          5 :         MOCK_SET(spdk_memzone_reserve, (void *)&dummy);
    1423                 :          5 :         g_spdk_nvme_driver = NULL;
    1424                 :          5 :         rc = nvme_driver_init();
    1425                 :          5 :         CU_ASSERT(rc == 0);
    1426                 :            : 
    1427                 :          5 :         ut_test_probe_internal = true;
    1428                 :          5 :         MOCK_SET(dummy_probe_cb, true);
    1429                 :          5 :         trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
    1430                 :          5 :         nvme_probe_ctx_init(probe_ctx, &trid, NULL, NULL, dummy_probe_cb, NULL, NULL);
    1431                 :          5 :         rc = nvme_probe_internal(probe_ctx, false);
    1432                 :          5 :         CU_ASSERT(rc < 0);
    1433                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&probe_ctx->init_ctrlrs));
    1434                 :            : 
    1435                 :          5 :         free(probe_ctx);
    1436                 :          5 :         ut_test_probe_internal = false;
    1437                 :          5 : }
    1438                 :            : 
    1439                 :            : static void
    1440                 :          5 : test_spdk_nvme_parse_func(void)
    1441                 :            : {
    1442                 :          5 :         struct spdk_nvme_host_id hostid = {};
    1443                 :          5 :         char str[64] = {};
    1444                 :          5 :         const char *rt_str = NULL;
    1445                 :          4 :         uint32_t prchk_flags;
    1446                 :            :         int rc;
    1447                 :            : 
    1448                 :            :         /* Parse prchk flags. */
    1449                 :          5 :         prchk_flags = 0;
    1450                 :          5 :         rt_str = spdk_nvme_prchk_flags_str(SPDK_NVME_IO_FLAGS_PRCHK_REFTAG);
    1451   [ -  +  -  + ]:          5 :         memcpy(str, rt_str, strlen(rt_str));
    1452                 :            : 
    1453                 :          5 :         rc = spdk_nvme_prchk_flags_parse(&prchk_flags, str);
    1454                 :          5 :         CU_ASSERT(rc == 0);
    1455                 :          5 :         CU_ASSERT(prchk_flags & SPDK_NVME_IO_FLAGS_PRCHK_REFTAG);
    1456                 :            : 
    1457                 :          5 :         prchk_flags = 0;
    1458                 :          5 :         rt_str = spdk_nvme_prchk_flags_str(SPDK_NVME_IO_FLAGS_PRCHK_GUARD);
    1459   [ -  +  -  + ]:          5 :         memcpy(str, rt_str, strlen(rt_str));
    1460                 :            : 
    1461                 :          5 :         rc = spdk_nvme_prchk_flags_parse(&prchk_flags, str);
    1462                 :          5 :         CU_ASSERT(prchk_flags & SPDK_NVME_IO_FLAGS_PRCHK_GUARD);
    1463                 :          5 :         CU_ASSERT(rc == 0);
    1464                 :            : 
    1465                 :          5 :         prchk_flags = 0;
    1466                 :          5 :         rt_str = spdk_nvme_prchk_flags_str(SPDK_NVME_IO_FLAGS_PRCHK_REFTAG |
    1467                 :            :                                            SPDK_NVME_IO_FLAGS_PRCHK_GUARD);
    1468   [ -  +  -  + ]:          5 :         memcpy(str, rt_str, strlen(rt_str));
    1469                 :            : 
    1470                 :          5 :         rc = spdk_nvme_prchk_flags_parse(&prchk_flags, str);
    1471                 :          5 :         CU_ASSERT(rc == 0);
    1472                 :          5 :         CU_ASSERT(prchk_flags & SPDK_NVME_IO_FLAGS_PRCHK_REFTAG);
    1473                 :          5 :         CU_ASSERT(prchk_flags & SPDK_NVME_IO_FLAGS_PRCHK_GUARD);
    1474                 :            : 
    1475                 :          5 :         rc = spdk_nvme_prchk_flags_parse(NULL, NULL);
    1476                 :          5 :         CU_ASSERT(rc == -EINVAL);
    1477                 :            : 
    1478                 :            :         /* Parse host id. */
    1479                 :          5 :         memcpy(str, "hostaddr:192.168.1.1", sizeof("hostaddr:192.168.1.1"));
    1480                 :          5 :         rc = spdk_nvme_host_id_parse(&hostid, str);
    1481                 :          5 :         CU_ASSERT(rc == 0);
    1482                 :          5 :         CU_ASSERT(!strncmp(hostid.hostaddr, "192.168.1.1", sizeof("192.168.1.1")));
    1483                 :            : 
    1484                 :          5 :         memset(&hostid, 0, sizeof(hostid));
    1485                 :          5 :         memcpy(str, "hostsvcid:192.168.1.2", sizeof("hostsvcid:192.168.1.2"));
    1486                 :          5 :         rc = spdk_nvme_host_id_parse(&hostid, str);
    1487                 :          5 :         CU_ASSERT(rc == 0);
    1488                 :          5 :         CU_ASSERT(!strncmp(hostid.hostsvcid, "192.168.1.2", sizeof("192.168.1.2")));
    1489                 :            : 
    1490                 :            :         /* Unknown transport ID key */
    1491                 :          5 :         memset(&hostid, 0, sizeof(hostid));
    1492                 :          5 :         memcpy(str, "trtype:xxx", sizeof("trtype:xxx"));
    1493                 :          5 :         rc = spdk_nvme_host_id_parse(&hostid, str);
    1494                 :          5 :         CU_ASSERT(rc == 0);
    1495   [ +  -  +  - ]:          5 :         CU_ASSERT(hostid.hostaddr[0] == '\0' && hostid.hostsvcid[0] == '\0');
    1496                 :          5 : }
    1497                 :            : 
    1498                 :            : static void
    1499                 :          5 : test_spdk_nvme_detach_async(void)
    1500                 :            : {
    1501                 :          5 :         int rc = 1;
    1502                 :          4 :         struct spdk_nvme_ctrlr ctrlr1, ctrlr2;
    1503                 :          5 :         struct nvme_driver test_driver = {};
    1504                 :          4 :         struct spdk_nvme_detach_ctx *detach_ctx;
    1505                 :            :         struct nvme_ctrlr_detach_ctx *ctx;
    1506                 :            : 
    1507                 :          5 :         detach_ctx = NULL;
    1508         [ -  + ]:          5 :         memset(&ctrlr1, 0, sizeof(ctrlr1));
    1509                 :          5 :         ctrlr1.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
    1510         [ -  + ]:          5 :         memset(&ctrlr2, 0, sizeof(ctrlr2));
    1511                 :          5 :         ctrlr2.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
    1512                 :            : 
    1513                 :          5 :         g_spdk_nvme_driver = &test_driver;
    1514                 :          5 :         TAILQ_INIT(&test_driver.shared_attached_ctrlrs);
    1515                 :          5 :         TAILQ_INSERT_TAIL(&test_driver.shared_attached_ctrlrs, &ctrlr1, tailq);
    1516                 :          5 :         TAILQ_INSERT_TAIL(&test_driver.shared_attached_ctrlrs, &ctrlr2, tailq);
    1517         [ -  + ]:          5 :         CU_ASSERT(pthread_mutex_init(&test_driver.lock, NULL) == 0);
    1518                 :          5 :         MOCK_SET(nvme_ctrlr_get_ref_count, 1);
    1519                 :            : 
    1520                 :          5 :         rc = spdk_nvme_detach_async(&ctrlr1, &detach_ctx);
    1521                 :          5 :         CU_ASSERT(rc == 0);
    1522         [ -  + ]:          5 :         CU_ASSERT(ctrlr1.is_destructed == true);
    1523                 :          5 :         CU_ASSERT(detach_ctx != NULL);
    1524                 :            : 
    1525                 :          5 :         rc = spdk_nvme_detach_async(&ctrlr2, &detach_ctx);
    1526                 :          5 :         CU_ASSERT(rc == 0);
    1527         [ -  + ]:          5 :         CU_ASSERT(ctrlr2.is_destructed == true);
    1528                 :          5 :         CU_ASSERT(detach_ctx != NULL);
    1529                 :            : 
    1530                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&test_driver.shared_attached_ctrlrs) == false);
    1531                 :            : 
    1532                 :          5 :         rc = spdk_nvme_detach_poll_async(detach_ctx);
    1533                 :          5 :         CU_ASSERT(rc == 0);
    1534                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&test_driver.shared_attached_ctrlrs) == true);
    1535                 :            : 
    1536                 :            :         /* ctrlr1 is a PCIe controller but ctrlr2 is an non-PCIe controller.
    1537                 :            :          * Even for this case, detachment should complete successfully.
    1538                 :            :          */
    1539                 :          5 :         detach_ctx = NULL;
    1540         [ -  + ]:          5 :         memset(&ctrlr1, 0, sizeof(ctrlr1));
    1541                 :          5 :         ctrlr1.trid.trtype = SPDK_NVME_TRANSPORT_RDMA;
    1542         [ -  + ]:          5 :         memset(&ctrlr2, 0, sizeof(ctrlr2));
    1543                 :          5 :         ctrlr2.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
    1544                 :          5 :         TAILQ_INIT(&g_nvme_attached_ctrlrs);
    1545                 :          5 :         TAILQ_INSERT_TAIL(&g_nvme_attached_ctrlrs, &ctrlr1, tailq);
    1546                 :          5 :         TAILQ_INSERT_TAIL(&test_driver.shared_attached_ctrlrs, &ctrlr2, tailq);
    1547                 :            : 
    1548                 :          5 :         rc = spdk_nvme_detach_async(&ctrlr1, &detach_ctx);
    1549                 :          5 :         CU_ASSERT(rc == 0);
    1550         [ -  + ]:          5 :         CU_ASSERT(ctrlr1.is_destructed == true);
    1551                 :          5 :         CU_ASSERT(detach_ctx != NULL);
    1552                 :            : 
    1553                 :          5 :         rc = spdk_nvme_detach_async(&ctrlr2, &detach_ctx);
    1554                 :          5 :         CU_ASSERT(rc == 0);
    1555         [ -  + ]:          5 :         CU_ASSERT(ctrlr2.is_destructed == true);
    1556                 :          5 :         CU_ASSERT(detach_ctx != NULL);
    1557                 :            : 
    1558                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_nvme_attached_ctrlrs) == false);
    1559                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&test_driver.shared_attached_ctrlrs) == false);
    1560                 :            : 
    1561                 :          5 :         rc = spdk_nvme_detach_poll_async(detach_ctx);
    1562                 :          5 :         CU_ASSERT(rc == 0);
    1563                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&g_nvme_attached_ctrlrs) == true);
    1564                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&test_driver.shared_attached_ctrlrs) == true);
    1565                 :            : 
    1566                 :            :         /* Test if ctrlr2 can be detached by using the same context that
    1567                 :            :          * ctrlr1 uses while ctrlr1 is being detached.
    1568                 :            :          */
    1569                 :          5 :         detach_ctx = NULL;
    1570         [ -  + ]:          5 :         memset(&ctrlr1, 0, sizeof(ctrlr1));
    1571                 :          5 :         ctrlr1.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
    1572         [ -  + ]:          5 :         memset(&ctrlr2, 0, sizeof(ctrlr2));
    1573                 :          5 :         ctrlr2.trid.trtype = SPDK_NVME_TRANSPORT_PCIE;
    1574                 :          5 :         TAILQ_INSERT_TAIL(&test_driver.shared_attached_ctrlrs, &ctrlr1, tailq);
    1575                 :          5 :         TAILQ_INSERT_TAIL(&test_driver.shared_attached_ctrlrs, &ctrlr2, tailq);
    1576                 :            : 
    1577                 :          5 :         rc = spdk_nvme_detach_async(&ctrlr1, &detach_ctx);
    1578                 :          5 :         CU_ASSERT(rc == 0);
    1579         [ -  + ]:          5 :         CU_ASSERT(ctrlr1.is_destructed == true);
    1580         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(detach_ctx != NULL);
    1581                 :            : 
    1582                 :          5 :         ctx = TAILQ_FIRST(&detach_ctx->head);
    1583         [ -  + ]:          5 :         SPDK_CU_ASSERT_FATAL(ctx != NULL);
    1584                 :          5 :         CU_ASSERT(ctx->ctrlr == &ctrlr1);
    1585         [ -  + ]:          5 :         CU_ASSERT(ctx->shutdown_complete == true);
    1586                 :            : 
    1587                 :            :         /* Set ctx->shutdown_complete for ctrlr1 to false to allow ctrlr2 to
    1588                 :            :          * add to detach_ctx while spdk_nvme_detach_poll_async() is being
    1589                 :            :          * executed.
    1590                 :            :          */
    1591                 :          5 :         ctx->shutdown_complete = false;
    1592                 :            : 
    1593                 :          5 :         rc = spdk_nvme_detach_poll_async(detach_ctx);
    1594                 :          5 :         CU_ASSERT(rc == -EAGAIN);
    1595                 :            : 
    1596                 :          5 :         rc = spdk_nvme_detach_async(&ctrlr2, &detach_ctx);
    1597                 :          5 :         CU_ASSERT(rc == 0);
    1598         [ -  + ]:          5 :         CU_ASSERT(ctrlr2.is_destructed == true);
    1599                 :            : 
    1600                 :            :         /* After ctrlr2 is added to detach_ctx, set ctx->shutdown_complete for
    1601                 :            :          * ctrlr1 to true to complete spdk_nvme_detach_poll_async().
    1602                 :            :          */
    1603                 :          5 :         ctx->shutdown_complete = true;
    1604                 :            : 
    1605                 :          5 :         rc = spdk_nvme_detach_poll_async(detach_ctx);
    1606                 :          5 :         CU_ASSERT(rc == 0);
    1607                 :          5 :         CU_ASSERT(TAILQ_EMPTY(&test_driver.shared_attached_ctrlrs) == true);
    1608                 :            : 
    1609                 :          5 :         g_spdk_nvme_driver = NULL;
    1610         [ -  + ]:          5 :         pthread_mutex_destroy(&test_driver.lock);
    1611   [ -  -  -  + ]:          5 :         MOCK_CLEAR(nvme_ctrlr_get_ref_count);
    1612                 :          5 : }
    1613                 :            : 
    1614                 :            : static void
    1615                 :          5 : test_nvme_parse_addr(void)
    1616                 :            : {
    1617                 :          4 :         struct sockaddr_storage dst_addr;
    1618                 :          5 :         int rc = 0;
    1619                 :          4 :         long int port;
    1620                 :            : 
    1621         [ -  + ]:          5 :         memset(&dst_addr, 0, sizeof(dst_addr));
    1622                 :            :         /* case1: getaddrinfo failed */
    1623                 :          5 :         rc = nvme_parse_addr(&dst_addr, AF_INET, NULL, NULL, &port);
    1624                 :          5 :         CU_ASSERT(rc != 0);
    1625                 :            : 
    1626                 :            :         /* case2: res->ai_addrlen < sizeof(*sa). Expect: Pass. */
    1627                 :          5 :         rc = nvme_parse_addr(&dst_addr, AF_INET, "12.34.56.78", "23", &port);
    1628                 :          5 :         CU_ASSERT(rc == 0);
    1629                 :          5 :         CU_ASSERT(port == 23);
    1630                 :          5 :         CU_ASSERT(dst_addr.ss_family == AF_INET);
    1631                 :          5 : }
    1632                 :            : 
    1633                 :            : int
    1634                 :          5 : main(int argc, char **argv)
    1635                 :            : {
    1636                 :          5 :         CU_pSuite       suite = NULL;
    1637                 :            :         unsigned int    num_failures;
    1638                 :            : 
    1639                 :          5 :         CU_initialize_registry();
    1640                 :            : 
    1641                 :          5 :         suite = CU_add_suite("nvme", NULL, NULL);
    1642                 :            : 
    1643                 :          5 :         CU_ADD_TEST(suite, test_opc_data_transfer);
    1644                 :          5 :         CU_ADD_TEST(suite, test_spdk_nvme_transport_id_parse_trtype);
    1645                 :          5 :         CU_ADD_TEST(suite, test_spdk_nvme_transport_id_parse_adrfam);
    1646                 :          5 :         CU_ADD_TEST(suite, test_trid_parse_and_compare);
    1647                 :          5 :         CU_ADD_TEST(suite, test_trid_trtype_str);
    1648                 :          5 :         CU_ADD_TEST(suite, test_trid_adrfam_str);
    1649                 :          5 :         CU_ADD_TEST(suite, test_nvme_ctrlr_probe);
    1650                 :          5 :         CU_ADD_TEST(suite, test_spdk_nvme_probe);
    1651                 :          5 :         CU_ADD_TEST(suite, test_spdk_nvme_connect);
    1652                 :          5 :         CU_ADD_TEST(suite, test_nvme_ctrlr_probe_internal);
    1653                 :          5 :         CU_ADD_TEST(suite, test_nvme_init_controllers);
    1654                 :          5 :         CU_ADD_TEST(suite, test_nvme_driver_init);
    1655                 :          5 :         CU_ADD_TEST(suite, test_spdk_nvme_detach);
    1656                 :          5 :         CU_ADD_TEST(suite, test_nvme_completion_poll_cb);
    1657                 :          5 :         CU_ADD_TEST(suite, test_nvme_user_copy_cmd_complete);
    1658                 :          5 :         CU_ADD_TEST(suite, test_nvme_allocate_request_null);
    1659                 :          5 :         CU_ADD_TEST(suite, test_nvme_allocate_request);
    1660                 :          5 :         CU_ADD_TEST(suite, test_nvme_free_request);
    1661                 :          5 :         CU_ADD_TEST(suite, test_nvme_allocate_request_user_copy);
    1662                 :          5 :         CU_ADD_TEST(suite, test_nvme_robust_mutex_init_shared);
    1663                 :          5 :         CU_ADD_TEST(suite, test_nvme_request_check_timeout);
    1664                 :          5 :         CU_ADD_TEST(suite, test_nvme_wait_for_completion);
    1665                 :          5 :         CU_ADD_TEST(suite, test_spdk_nvme_parse_func);
    1666                 :          5 :         CU_ADD_TEST(suite, test_spdk_nvme_detach_async);
    1667                 :          5 :         CU_ADD_TEST(suite, test_nvme_parse_addr);
    1668                 :            : 
    1669                 :          5 :         num_failures = spdk_ut_run_tests(argc, argv, NULL);
    1670                 :          5 :         CU_cleanup_registry();
    1671                 :          5 :         return num_failures;
    1672                 :            : }

Generated by: LCOV version 1.14