LCOV - code coverage report
Current view: top level - spdk/lib/nvme - nvme_pcie.c (source / functions) Hit Total Coverage
Test: Combined Lines: 401 530 75.7 %
Date: 2024-07-12 17:03:22 Functions: 42 45 93.3 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 180 312 57.7 %

           Branch data     Line data    Source code
       1                 :            : /*   SPDX-License-Identifier: BSD-3-Clause
       2                 :            :  *   Copyright (C) 2016 Intel Corporation. All rights reserved.
       3                 :            :  *   Copyright (c) 2017, IBM Corporation. All rights reserved.
       4                 :            :  *   Copyright (c) 2019-2021 Mellanox Technologies LTD. All rights reserved.
       5                 :            :  */
       6                 :            : 
       7                 :            : /*
       8                 :            :  * NVMe over PCIe transport
       9                 :            :  */
      10                 :            : 
      11                 :            : #include "spdk/stdinc.h"
      12                 :            : #include "spdk/env.h"
      13                 :            : #include "spdk/likely.h"
      14                 :            : #include "spdk/string.h"
      15                 :            : #include "nvme_internal.h"
      16                 :            : #include "nvme_pcie_internal.h"
      17                 :            : 
      18                 :            : struct nvme_pcie_enum_ctx {
      19                 :            :         struct spdk_nvme_probe_ctx *probe_ctx;
      20                 :            :         struct spdk_pci_addr pci_addr;
      21                 :            :         bool has_pci_addr;
      22                 :            : };
      23                 :            : 
      24                 :            : static uint16_t g_signal_lock;
      25                 :            : static bool g_sigset = false;
      26                 :            : static spdk_nvme_pcie_hotplug_filter_cb g_hotplug_filter_cb;
      27                 :            : 
      28                 :            : static void
      29                 :          0 : nvme_sigbus_fault_sighandler(const void *failure_addr, void *ctx)
      30                 :            : {
      31                 :            :         void *map_address;
      32                 :          0 :         uint16_t flag = 0;
      33                 :            : 
      34         [ #  # ]:          0 :         if (!__atomic_compare_exchange_n(&g_signal_lock, &flag, 1, false, __ATOMIC_ACQUIRE,
      35                 :            :                                          __ATOMIC_RELAXED)) {
      36   [ #  #  #  # ]:          0 :                 SPDK_DEBUGLOG(nvme, "request g_signal_lock failed\n");
      37                 :          0 :                 return;
      38                 :            :         }
      39                 :            : 
      40         [ #  # ]:          0 :         if (g_thread_mmio_ctrlr == NULL) {
      41                 :          0 :                 return;
      42                 :            :         }
      43                 :            : 
      44   [ #  #  #  # ]:          0 :         if (!g_thread_mmio_ctrlr->is_remapped) {
      45                 :          0 :                 map_address = mmap((void *)g_thread_mmio_ctrlr->regs, g_thread_mmio_ctrlr->regs_size,
      46                 :            :                                    PROT_READ | PROT_WRITE,
      47                 :            :                                    MAP_PRIVATE | MAP_ANONYMOUS | MAP_FIXED, -1, 0);
      48         [ #  # ]:          0 :                 if (map_address == MAP_FAILED) {
      49                 :          0 :                         SPDK_ERRLOG("mmap failed\n");
      50                 :          0 :                         __atomic_store_n(&g_signal_lock, 0, __ATOMIC_RELEASE);
      51                 :          0 :                         return;
      52                 :            :                 }
      53         [ #  # ]:          0 :                 memset(map_address, 0xFF, sizeof(struct spdk_nvme_registers));
      54                 :          0 :                 g_thread_mmio_ctrlr->regs = (volatile struct spdk_nvme_registers *)map_address;
      55                 :          0 :                 g_thread_mmio_ctrlr->is_remapped = true;
      56                 :            :         }
      57                 :          0 :         __atomic_store_n(&g_signal_lock, 0, __ATOMIC_RELEASE);
      58                 :            : }
      59                 :            : 
      60                 :            : static void
      61                 :        133 : _nvme_pcie_event_process(struct spdk_pci_event *event, void *cb_ctx)
      62                 :            : {
      63                 :         79 :         struct spdk_nvme_transport_id trid;
      64                 :            :         struct spdk_nvme_ctrlr *ctrlr;
      65                 :            : 
      66         [ +  + ]:        133 :         if (event->action == SPDK_UEVENT_ADD) {
      67         [ +  - ]:         66 :                 if (spdk_process_is_primary()) {
      68   [ -  +  -  - ]:         66 :                         if (g_hotplug_filter_cb == NULL || g_hotplug_filter_cb(&event->traddr)) {
      69                 :            :                                 /* The enumerate interface implement the add operation */
      70                 :         66 :                                 spdk_pci_device_allow(&event->traddr);
      71                 :            :                         }
      72                 :            :                 }
      73         [ +  - ]:         67 :         } else if (event->action == SPDK_UEVENT_REMOVE) {
      74         [ -  + ]:         67 :                 memset(&trid, 0, sizeof(trid));
      75                 :         67 :                 spdk_nvme_trid_populate_transport(&trid, SPDK_NVME_TRANSPORT_PCIE);
      76                 :            : 
      77         [ -  + ]:         67 :                 if (spdk_pci_addr_fmt(trid.traddr, sizeof(trid.traddr), &event->traddr) < 0) {
      78                 :          0 :                         SPDK_ERRLOG("Failed to format pci address\n");
      79                 :          0 :                         return;
      80                 :            :                 }
      81                 :            : 
      82                 :         67 :                 ctrlr = nvme_get_ctrlr_by_trid_unsafe(&trid, NULL);
      83         [ -  + ]:         67 :                 if (ctrlr == NULL) {
      84                 :          0 :                         return;
      85                 :            :                 }
      86   [ -  +  -  + ]:         67 :                 SPDK_DEBUGLOG(nvme, "remove nvme address: %s\n", trid.traddr);
      87                 :            : 
      88                 :         67 :                 nvme_ctrlr_lock(ctrlr);
      89                 :         67 :                 nvme_ctrlr_fail(ctrlr, true);
      90                 :         67 :                 nvme_ctrlr_unlock(ctrlr);
      91                 :            : 
      92                 :            :                 /* get the user app to clean up and stop I/O */
      93         [ +  + ]:         67 :                 if (ctrlr->remove_cb) {
      94                 :         63 :                         nvme_robust_mutex_unlock(&g_spdk_nvme_driver->lock);
      95                 :         63 :                         ctrlr->remove_cb(ctrlr->cb_ctx, ctrlr);
      96                 :         63 :                         nvme_robust_mutex_lock(&g_spdk_nvme_driver->lock);
      97                 :            :                 }
      98                 :            :         }
      99                 :            : }
     100                 :            : 
     101                 :            : static int
     102                 :      84539 : _nvme_pcie_hotplug_monitor(struct spdk_nvme_probe_ctx *probe_ctx)
     103                 :            : {
     104                 :            :         struct spdk_nvme_ctrlr *ctrlr, *tmp;
     105                 :      38879 :         struct spdk_pci_event event;
     106                 :      84539 :         int rc = 0;
     107                 :            : 
     108         [ +  - ]:      84539 :         if (g_spdk_nvme_driver->hotplug_fd >= 0) {
     109         [ +  + ]:      84672 :                 while (spdk_pci_get_event(g_spdk_nvme_driver->hotplug_fd, &event) > 0) {
     110                 :        133 :                         _nvme_pcie_event_process(&event, probe_ctx->cb_ctx);
     111                 :            :                 }
     112                 :            :         }
     113                 :            : 
     114                 :            :         /* Initiate removal of physically hotremoved PCI controllers. Even after
     115                 :            :          * they're hotremoved from the system, SPDK might still report them via RPC.
     116                 :            :          */
     117         [ +  + ]:     203380 :         TAILQ_FOREACH_SAFE(ctrlr, &g_spdk_nvme_driver->shared_attached_ctrlrs, tailq, tmp) {
     118                 :     118841 :                 bool do_remove = false;
     119                 :            :                 struct nvme_pcie_ctrlr *pctrlr;
     120                 :            : 
     121         [ -  + ]:     118841 :                 if (ctrlr->trid.trtype != SPDK_NVME_TRANSPORT_PCIE) {
     122                 :          0 :                         continue;
     123                 :            :                 }
     124                 :            : 
     125                 :     118841 :                 pctrlr = nvme_pcie_ctrlr(ctrlr);
     126         [ +  + ]:     118841 :                 if (spdk_pci_device_is_removed(pctrlr->devhandle)) {
     127                 :          8 :                         do_remove = true;
     128                 :          8 :                         rc = 1;
     129                 :            :                 }
     130                 :            : 
     131         [ +  + ]:     118841 :                 if (do_remove) {
     132                 :          8 :                         nvme_ctrlr_lock(ctrlr);
     133                 :          8 :                         nvme_ctrlr_fail(ctrlr, true);
     134                 :          8 :                         nvme_ctrlr_unlock(ctrlr);
     135         [ -  + ]:          8 :                         if (ctrlr->remove_cb) {
     136                 :          0 :                                 nvme_robust_mutex_unlock(&g_spdk_nvme_driver->lock);
     137                 :          0 :                                 ctrlr->remove_cb(ctrlr->cb_ctx, ctrlr);
     138                 :          0 :                                 nvme_robust_mutex_lock(&g_spdk_nvme_driver->lock);
     139                 :            :                         }
     140                 :            :                 }
     141                 :            :         }
     142                 :      84539 :         return rc;
     143                 :            : }
     144                 :            : 
     145                 :            : static volatile void *
     146                 :    1144116 : nvme_pcie_reg_addr(struct spdk_nvme_ctrlr *ctrlr, uint32_t offset)
     147                 :            : {
     148                 :    1144116 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     149                 :            : 
     150                 :    1144116 :         return (volatile void *)((uintptr_t)pctrlr->regs + offset);
     151                 :            : }
     152                 :            : 
     153                 :            : static volatile struct spdk_nvme_registers *
     154                 :          9 : nvme_pcie_ctrlr_get_registers(struct spdk_nvme_ctrlr *ctrlr)
     155                 :            : {
     156                 :          9 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     157                 :            : 
     158                 :          9 :         return pctrlr->regs;
     159                 :            : }
     160                 :            : 
     161                 :            : static int
     162                 :       3261 : nvme_pcie_ctrlr_set_reg_4(struct spdk_nvme_ctrlr *ctrlr, uint32_t offset, uint32_t value)
     163                 :            : {
     164                 :       3261 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     165                 :            : 
     166         [ -  + ]:       3261 :         assert(offset <= sizeof(struct spdk_nvme_registers) - 4);
     167                 :       3261 :         g_thread_mmio_ctrlr = pctrlr;
     168                 :       3261 :         spdk_mmio_write_4(nvme_pcie_reg_addr(ctrlr, offset), value);
     169                 :       3261 :         g_thread_mmio_ctrlr = NULL;
     170                 :       3261 :         return 0;
     171                 :            : }
     172                 :            : 
     173                 :            : static int
     174                 :       1462 : nvme_pcie_ctrlr_set_reg_8(struct spdk_nvme_ctrlr *ctrlr, uint32_t offset, uint64_t value)
     175                 :            : {
     176                 :       1462 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     177                 :            : 
     178         [ -  + ]:       1462 :         assert(offset <= sizeof(struct spdk_nvme_registers) - 8);
     179                 :       1462 :         g_thread_mmio_ctrlr = pctrlr;
     180                 :       1462 :         spdk_mmio_write_8(nvme_pcie_reg_addr(ctrlr, offset), value);
     181                 :       1462 :         g_thread_mmio_ctrlr = NULL;
     182                 :       1462 :         return 0;
     183                 :            : }
     184                 :            : 
     185                 :            : static int
     186                 :    1138007 : nvme_pcie_ctrlr_get_reg_4(struct spdk_nvme_ctrlr *ctrlr, uint32_t offset, uint32_t *value)
     187                 :            : {
     188                 :    1138007 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     189                 :            : 
     190         [ -  + ]:    1138007 :         assert(offset <= sizeof(struct spdk_nvme_registers) - 4);
     191         [ -  + ]:    1138007 :         assert(value != NULL);
     192                 :    1138007 :         g_thread_mmio_ctrlr = pctrlr;
     193                 :    1138007 :         *value = spdk_mmio_read_4(nvme_pcie_reg_addr(ctrlr, offset));
     194                 :    1138007 :         g_thread_mmio_ctrlr = NULL;
     195         [ -  + ]:    1138007 :         if (~(*value) == 0) {
     196                 :          0 :                 return -1;
     197                 :            :         }
     198                 :            : 
     199                 :    1138007 :         return 0;
     200                 :            : }
     201                 :            : 
     202                 :            : static int
     203                 :       1386 : nvme_pcie_ctrlr_get_reg_8(struct spdk_nvme_ctrlr *ctrlr, uint32_t offset, uint64_t *value)
     204                 :            : {
     205                 :       1386 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     206                 :            : 
     207         [ -  + ]:       1386 :         assert(offset <= sizeof(struct spdk_nvme_registers) - 8);
     208         [ -  + ]:       1386 :         assert(value != NULL);
     209                 :       1386 :         g_thread_mmio_ctrlr = pctrlr;
     210                 :       1386 :         *value = spdk_mmio_read_8(nvme_pcie_reg_addr(ctrlr, offset));
     211                 :       1386 :         g_thread_mmio_ctrlr = NULL;
     212         [ -  + ]:       1386 :         if (~(*value) == 0) {
     213                 :          0 :                 return -1;
     214                 :            :         }
     215                 :            : 
     216                 :       1386 :         return 0;
     217                 :            : }
     218                 :            : 
     219                 :            : static int
     220                 :        727 : nvme_pcie_ctrlr_set_asq(struct nvme_pcie_ctrlr *pctrlr, uint64_t value)
     221                 :            : {
     222                 :        727 :         return nvme_pcie_ctrlr_set_reg_8(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, asq),
     223                 :            :                                          value);
     224                 :            : }
     225                 :            : 
     226                 :            : static int
     227                 :        727 : nvme_pcie_ctrlr_set_acq(struct nvme_pcie_ctrlr *pctrlr, uint64_t value)
     228                 :            : {
     229                 :        727 :         return nvme_pcie_ctrlr_set_reg_8(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, acq),
     230                 :            :                                          value);
     231                 :            : }
     232                 :            : 
     233                 :            : static int
     234                 :        727 : nvme_pcie_ctrlr_set_aqa(struct nvme_pcie_ctrlr *pctrlr, const union spdk_nvme_aqa_register *aqa)
     235                 :            : {
     236                 :        925 :         return nvme_pcie_ctrlr_set_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, aqa.raw),
     237                 :        622 :                                          aqa->raw);
     238                 :            : }
     239                 :            : 
     240                 :            : static int
     241                 :        752 : nvme_pcie_ctrlr_get_cmbloc(struct nvme_pcie_ctrlr *pctrlr, union spdk_nvme_cmbloc_register *cmbloc)
     242                 :            : {
     243                 :        752 :         return nvme_pcie_ctrlr_get_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, cmbloc.raw),
     244                 :            :                                          &cmbloc->raw);
     245                 :            : }
     246                 :            : 
     247                 :            : static int
     248                 :        679 : nvme_pcie_ctrlr_get_cmbsz(struct nvme_pcie_ctrlr *pctrlr, union spdk_nvme_cmbsz_register *cmbsz)
     249                 :            : {
     250                 :        679 :         return nvme_pcie_ctrlr_get_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, cmbsz.raw),
     251                 :            :                                          &cmbsz->raw);
     252                 :            : }
     253                 :            : 
     254                 :            : static int
     255                 :        328 : nvme_pcie_ctrlr_get_pmrcap(struct nvme_pcie_ctrlr *pctrlr, union spdk_nvme_pmrcap_register *pmrcap)
     256                 :            : {
     257                 :        328 :         return nvme_pcie_ctrlr_get_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, pmrcap.raw),
     258                 :            :                                          &pmrcap->raw);
     259                 :            : }
     260                 :            : 
     261                 :            : static int
     262                 :        104 : nvme_pcie_ctrlr_set_pmrctl(struct nvme_pcie_ctrlr *pctrlr, union spdk_nvme_pmrctl_register *pmrctl)
     263                 :            : {
     264                 :        104 :         return nvme_pcie_ctrlr_set_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, pmrctl.raw),
     265                 :            :                                          pmrctl->raw);
     266                 :            : }
     267                 :            : 
     268                 :            : static int
     269                 :        108 : nvme_pcie_ctrlr_get_pmrctl(struct nvme_pcie_ctrlr *pctrlr, union spdk_nvme_pmrctl_register *pmrctl)
     270                 :            : {
     271                 :        108 :         return nvme_pcie_ctrlr_get_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, pmrctl.raw),
     272                 :            :                                          &pmrctl->raw);
     273                 :            : }
     274                 :            : 
     275                 :            : static int
     276                 :        191 : nvme_pcie_ctrlr_get_pmrsts(struct nvme_pcie_ctrlr *pctrlr, union spdk_nvme_pmrsts_register *pmrsts)
     277                 :            : {
     278                 :        191 :         return nvme_pcie_ctrlr_get_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, pmrsts.raw),
     279                 :            :                                          &pmrsts->raw);
     280                 :            : }
     281                 :            : 
     282                 :            : static int
     283                 :        168 : nvme_pcie_ctrlr_set_pmrmscl(struct nvme_pcie_ctrlr *pctrlr, uint32_t value)
     284                 :            : {
     285                 :        168 :         return nvme_pcie_ctrlr_set_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, pmrmscl.raw),
     286                 :            :                                          value);
     287                 :            : }
     288                 :            : 
     289                 :            : static int
     290                 :        168 : nvme_pcie_ctrlr_set_pmrmscu(struct nvme_pcie_ctrlr *pctrlr, uint32_t value)
     291                 :            : {
     292                 :        168 :         return nvme_pcie_ctrlr_set_reg_4(&pctrlr->ctrlr, offsetof(struct spdk_nvme_registers, pmrmscu),
     293                 :            :                                          value);
     294                 :            : }
     295                 :            : 
     296                 :            : static  uint32_t
     297                 :        727 : nvme_pcie_ctrlr_get_max_xfer_size(struct spdk_nvme_ctrlr *ctrlr)
     298                 :            : {
     299                 :            :         /*
     300                 :            :          * For commands requiring more than 2 PRP entries, one PRP will be
     301                 :            :          *  embedded in the command (prp1), and the rest of the PRP entries
     302                 :            :          *  will be in a list pointed to by the command (prp2).  The number
     303                 :            :          *  of PRP entries in the list is defined by
     304                 :            :          *  NVME_MAX_PRP_LIST_ENTRIES.
     305                 :            :          *
     306                 :            :          *  Note that the max xfer size is not (MAX_ENTRIES + 1) * page_size
     307                 :            :          *  because the first PRP entry may not be aligned on a 4KiB
     308                 :            :          *  boundary.
     309                 :            :          */
     310                 :        727 :         return NVME_MAX_PRP_LIST_ENTRIES * ctrlr->page_size;
     311                 :            : }
     312                 :            : 
     313                 :            : static uint16_t
     314                 :        677 : nvme_pcie_ctrlr_get_max_sges(struct spdk_nvme_ctrlr *ctrlr)
     315                 :            : {
     316                 :        677 :         return NVME_MAX_SGL_DESCRIPTORS;
     317                 :            : }
     318                 :            : 
     319                 :            : static void
     320                 :        663 : nvme_pcie_ctrlr_map_cmb(struct nvme_pcie_ctrlr *pctrlr)
     321                 :            : {
     322                 :            :         int rc;
     323                 :        663 :         void *addr = NULL;
     324                 :            :         uint32_t bir;
     325                 :        390 :         union spdk_nvme_cmbsz_register cmbsz;
     326                 :        390 :         union spdk_nvme_cmbloc_register cmbloc;
     327                 :        663 :         uint64_t size, unit_size, offset, bar_size = 0, bar_phys_addr = 0;
     328                 :            : 
     329   [ +  -  -  + ]:       1326 :         if (nvme_pcie_ctrlr_get_cmbsz(pctrlr, &cmbsz) ||
     330                 :        663 :             nvme_pcie_ctrlr_get_cmbloc(pctrlr, &cmbloc)) {
     331                 :          0 :                 SPDK_ERRLOG("get registers failed\n");
     332                 :          0 :                 goto exit;
     333                 :            :         }
     334                 :            : 
     335         [ +  + ]:        663 :         if (!cmbsz.bits.sz) {
     336                 :        568 :                 goto exit;
     337                 :            :         }
     338                 :            : 
     339                 :         95 :         bir = cmbloc.bits.bir;
     340                 :            :         /* Values 0 2 3 4 5 are valid for BAR */
     341   [ +  -  -  + ]:         95 :         if (bir > 5 || bir == 1) {
     342                 :          0 :                 goto exit;
     343                 :            :         }
     344                 :            : 
     345                 :            :         /* unit size for 4KB/64KB/1MB/16MB/256MB/4GB/64GB */
     346         [ -  + ]:         95 :         unit_size = (uint64_t)1 << (12 + 4 * cmbsz.bits.szu);
     347                 :            :         /* controller memory buffer size in Bytes */
     348                 :         95 :         size = unit_size * cmbsz.bits.sz;
     349                 :            :         /* controller memory buffer offset from BAR in Bytes */
     350                 :         95 :         offset = unit_size * cmbloc.bits.ofst;
     351                 :            : 
     352                 :         95 :         rc = spdk_pci_device_map_bar(pctrlr->devhandle, bir, &addr,
     353                 :            :                                      &bar_phys_addr, &bar_size);
     354   [ +  -  -  + ]:         95 :         if ((rc != 0) || addr == NULL) {
     355                 :          0 :                 goto exit;
     356                 :            :         }
     357                 :            : 
     358         [ -  + ]:         95 :         if (offset > bar_size) {
     359                 :          0 :                 goto exit;
     360                 :            :         }
     361                 :            : 
     362         [ -  + ]:         95 :         if (size > bar_size - offset) {
     363                 :          0 :                 goto exit;
     364                 :            :         }
     365                 :            : 
     366                 :         95 :         pctrlr->cmb.bar_va = addr;
     367                 :         95 :         pctrlr->cmb.bar_pa = bar_phys_addr;
     368                 :         95 :         pctrlr->cmb.size = size;
     369                 :         95 :         pctrlr->cmb.current_offset = offset;
     370                 :            : 
     371         [ +  + ]:         95 :         if (!cmbsz.bits.sqs) {
     372                 :          4 :                 pctrlr->ctrlr.opts.use_cmb_sqs = false;
     373                 :            :         }
     374                 :            : 
     375                 :         95 :         return;
     376                 :        568 : exit:
     377                 :        568 :         pctrlr->ctrlr.opts.use_cmb_sqs = false;
     378                 :        568 :         return;
     379                 :            : }
     380                 :            : 
     381                 :            : static int
     382                 :        592 : nvme_pcie_ctrlr_unmap_cmb(struct nvme_pcie_ctrlr *pctrlr)
     383                 :            : {
     384                 :        592 :         int rc = 0;
     385                 :        350 :         union spdk_nvme_cmbloc_register cmbloc;
     386                 :        592 :         void *addr = pctrlr->cmb.bar_va;
     387                 :            : 
     388         [ +  + ]:        592 :         if (addr) {
     389         [ -  + ]:         73 :                 if (pctrlr->cmb.mem_register_addr) {
     390                 :          0 :                         spdk_mem_unregister(pctrlr->cmb.mem_register_addr, pctrlr->cmb.mem_register_size);
     391                 :            :                 }
     392                 :            : 
     393         [ -  + ]:         73 :                 if (nvme_pcie_ctrlr_get_cmbloc(pctrlr, &cmbloc)) {
     394                 :          0 :                         SPDK_ERRLOG("get_cmbloc() failed\n");
     395                 :          0 :                         return -EIO;
     396                 :            :                 }
     397                 :         73 :                 rc = spdk_pci_device_unmap_bar(pctrlr->devhandle, cmbloc.bits.bir, addr);
     398                 :            :         }
     399                 :        592 :         return rc;
     400                 :            : }
     401                 :            : 
     402                 :            : static int
     403                 :          0 : nvme_pcie_ctrlr_reserve_cmb(struct spdk_nvme_ctrlr *ctrlr)
     404                 :            : {
     405                 :          0 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     406                 :            : 
     407         [ #  # ]:          0 :         if (pctrlr->cmb.bar_va == NULL) {
     408   [ #  #  #  # ]:          0 :                 SPDK_DEBUGLOG(nvme, "CMB not available\n");
     409                 :          0 :                 return -ENOTSUP;
     410                 :            :         }
     411                 :            : 
     412   [ #  #  #  # ]:          0 :         if (ctrlr->opts.use_cmb_sqs) {
     413                 :          0 :                 SPDK_ERRLOG("CMB is already in use for submission queues.\n");
     414                 :          0 :                 return -ENOTSUP;
     415                 :            :         }
     416                 :            : 
     417                 :          0 :         return 0;
     418                 :            : }
     419                 :            : 
     420                 :            : static void *
     421                 :         37 : nvme_pcie_ctrlr_map_io_cmb(struct spdk_nvme_ctrlr *ctrlr, size_t *size)
     422                 :            : {
     423                 :         37 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     424                 :         32 :         union spdk_nvme_cmbsz_register cmbsz;
     425                 :         32 :         union spdk_nvme_cmbloc_register cmbloc;
     426                 :            :         uint64_t mem_register_start, mem_register_end;
     427                 :            :         int rc;
     428                 :            : 
     429         [ +  + ]:         37 :         if (pctrlr->cmb.mem_register_addr != NULL) {
     430                 :          4 :                 *size = pctrlr->cmb.mem_register_size;
     431                 :          4 :                 return pctrlr->cmb.mem_register_addr;
     432                 :            :         }
     433                 :            : 
     434                 :         33 :         *size = 0;
     435                 :            : 
     436         [ +  + ]:         33 :         if (pctrlr->cmb.bar_va == NULL) {
     437   [ -  +  -  + ]:         13 :                 SPDK_DEBUGLOG(nvme, "CMB not available\n");
     438                 :         13 :                 return NULL;
     439                 :            :         }
     440                 :            : 
     441   [ +  +  +  + ]:         20 :         if (ctrlr->opts.use_cmb_sqs) {
     442                 :          4 :                 SPDK_ERRLOG("CMB is already in use for submission queues.\n");
     443                 :          4 :                 return NULL;
     444                 :            :         }
     445                 :            : 
     446   [ +  -  -  + ]:         32 :         if (nvme_pcie_ctrlr_get_cmbsz(pctrlr, &cmbsz) ||
     447                 :         16 :             nvme_pcie_ctrlr_get_cmbloc(pctrlr, &cmbloc)) {
     448                 :          0 :                 SPDK_ERRLOG("get registers failed\n");
     449                 :          0 :                 return NULL;
     450                 :            :         }
     451                 :            : 
     452                 :            :         /* If only SQS is supported */
     453   [ +  +  +  - ]:         16 :         if (!(cmbsz.bits.wds || cmbsz.bits.rds)) {
     454                 :          4 :                 return NULL;
     455                 :            :         }
     456                 :            : 
     457                 :            :         /* If CMB is less than 4MiB in size then abort CMB mapping */
     458         [ +  + ]:         12 :         if (pctrlr->cmb.size < (1ULL << 22)) {
     459                 :          4 :                 return NULL;
     460                 :            :         }
     461                 :            : 
     462                 :          8 :         mem_register_start = _2MB_PAGE((uintptr_t)pctrlr->cmb.bar_va + pctrlr->cmb.current_offset +
     463                 :            :                                        VALUE_2MB - 1);
     464                 :          8 :         mem_register_end = _2MB_PAGE((uintptr_t)pctrlr->cmb.bar_va + pctrlr->cmb.current_offset +
     465                 :            :                                      pctrlr->cmb.size);
     466                 :            : 
     467                 :          8 :         rc = spdk_mem_register((void *)mem_register_start, mem_register_end - mem_register_start);
     468         [ +  + ]:          8 :         if (rc) {
     469                 :          2 :                 SPDK_ERRLOG("spdk_mem_register() failed\n");
     470                 :          2 :                 return NULL;
     471                 :            :         }
     472                 :            : 
     473                 :          6 :         pctrlr->cmb.mem_register_addr = (void *)mem_register_start;
     474                 :          6 :         pctrlr->cmb.mem_register_size = mem_register_end - mem_register_start;
     475                 :            : 
     476                 :          6 :         *size = pctrlr->cmb.mem_register_size;
     477                 :          6 :         return pctrlr->cmb.mem_register_addr;
     478                 :            : }
     479                 :            : 
     480                 :            : static int
     481                 :          6 : nvme_pcie_ctrlr_unmap_io_cmb(struct spdk_nvme_ctrlr *ctrlr)
     482                 :            : {
     483                 :          6 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     484                 :            :         int rc;
     485                 :            : 
     486         [ -  + ]:          6 :         if (pctrlr->cmb.mem_register_addr == NULL) {
     487                 :          0 :                 return 0;
     488                 :            :         }
     489                 :            : 
     490                 :          6 :         rc = spdk_mem_unregister(pctrlr->cmb.mem_register_addr, pctrlr->cmb.mem_register_size);
     491                 :            : 
     492         [ +  - ]:          6 :         if (rc == 0) {
     493                 :          6 :                 pctrlr->cmb.mem_register_addr = NULL;
     494                 :          6 :                 pctrlr->cmb.mem_register_size = 0;
     495                 :            :         }
     496                 :            : 
     497                 :          6 :         return rc;
     498                 :            : }
     499                 :            : 
     500                 :            : static void
     501                 :        663 : nvme_pcie_ctrlr_map_pmr(struct nvme_pcie_ctrlr *pctrlr)
     502                 :            : {
     503                 :            :         int rc;
     504                 :        663 :         void *addr = NULL;
     505                 :            :         uint32_t bir;
     506                 :        390 :         union spdk_nvme_pmrcap_register pmrcap;
     507                 :        663 :         uint64_t bar_size = 0, bar_phys_addr = 0;
     508                 :            : 
     509         [ +  + ]:        663 :         if (!pctrlr->regs->cap.bits.pmrs) {
     510                 :        564 :                 return;
     511                 :            :         }
     512                 :            : 
     513         [ -  + ]:         99 :         if (nvme_pcie_ctrlr_get_pmrcap(pctrlr, &pmrcap)) {
     514                 :          0 :                 SPDK_ERRLOG("get registers failed\n");
     515                 :          0 :                 return;
     516                 :            :         }
     517                 :            : 
     518                 :         99 :         bir = pmrcap.bits.bir;
     519                 :            :         /* Values 2 3 4 5 are valid for BAR */
     520   [ +  -  +  + ]:         99 :         if (bir > 5 || bir < 2) {
     521                 :          4 :                 SPDK_ERRLOG("invalid base indicator register value\n");
     522                 :          4 :                 return;
     523                 :            :         }
     524                 :            : 
     525                 :         95 :         rc = spdk_pci_device_map_bar(pctrlr->devhandle, bir, &addr, &bar_phys_addr, &bar_size);
     526   [ +  -  -  + ]:         95 :         if ((rc != 0) || addr == NULL) {
     527                 :          0 :                 SPDK_ERRLOG("could not map the bar %d\n", bir);
     528                 :          0 :                 return;
     529                 :            :         }
     530                 :            : 
     531         [ +  - ]:         95 :         if (pmrcap.bits.cmss) {
     532                 :         95 :                 uint32_t pmrmscl, pmrmscu, cmse = 1;
     533                 :          4 :                 union spdk_nvme_pmrsts_register pmrsts;
     534                 :            : 
     535                 :            :                 /* Enable Controller Memory Space */
     536                 :         95 :                 pmrmscl = (uint32_t)((bar_phys_addr & 0xFFFFF000ULL) | (cmse << 1));
     537                 :         95 :                 pmrmscu = (uint32_t)((bar_phys_addr >> 32ULL) & 0xFFFFFFFFULL);
     538                 :            : 
     539         [ -  + ]:         95 :                 if (nvme_pcie_ctrlr_set_pmrmscu(pctrlr, pmrmscu)) {
     540                 :          0 :                         SPDK_ERRLOG("set_pmrmscu() failed\n");
     541                 :          0 :                         spdk_pci_device_unmap_bar(pctrlr->devhandle, bir, addr);
     542                 :          0 :                         return;
     543                 :            :                 }
     544                 :            : 
     545         [ -  + ]:         95 :                 if (nvme_pcie_ctrlr_set_pmrmscl(pctrlr, pmrmscl)) {
     546                 :          0 :                         SPDK_ERRLOG("set_pmrmscl() failed\n");
     547                 :          0 :                         spdk_pci_device_unmap_bar(pctrlr->devhandle, bir, addr);
     548                 :          0 :                         return;
     549                 :            :                 }
     550                 :            : 
     551         [ -  + ]:         95 :                 if (nvme_pcie_ctrlr_get_pmrsts(pctrlr, &pmrsts)) {
     552                 :          0 :                         SPDK_ERRLOG("get pmrsts failed\n");
     553                 :          0 :                         spdk_pci_device_unmap_bar(pctrlr->devhandle, bir, addr);
     554                 :          0 :                         return;
     555                 :            :                 }
     556                 :            : 
     557         [ -  + ]:         95 :                 if (pmrsts.bits.cbai) {
     558                 :          0 :                         SPDK_ERRLOG("Controller Memory Space Enable Failure\n");
     559                 :          0 :                         SPDK_ERRLOG("CBA Invalid - Host Addresses cannot reference PMR\n");
     560                 :            :                 } else {
     561   [ -  +  -  + ]:         95 :                         SPDK_DEBUGLOG(nvme, "Controller Memory Space Enable Success\n");
     562   [ -  +  -  + ]:         95 :                         SPDK_DEBUGLOG(nvme, "Host Addresses can reference PMR\n");
     563                 :            :                 }
     564                 :            :         }
     565                 :            : 
     566                 :         95 :         pctrlr->pmr.bar_va = addr;
     567                 :         95 :         pctrlr->pmr.bar_pa = bar_phys_addr;
     568                 :         95 :         pctrlr->pmr.size = pctrlr->ctrlr.pmr_size = bar_size;
     569                 :            : }
     570                 :            : 
     571                 :            : static int
     572                 :        592 : nvme_pcie_ctrlr_unmap_pmr(struct nvme_pcie_ctrlr *pctrlr)
     573                 :            : {
     574                 :        592 :         int rc = 0;
     575                 :        350 :         union spdk_nvme_pmrcap_register pmrcap;
     576                 :        592 :         void *addr = pctrlr->pmr.bar_va;
     577                 :            : 
     578         [ +  + ]:        592 :         if (addr == NULL) {
     579                 :        519 :                 return rc;
     580                 :            :         }
     581                 :            : 
     582         [ -  + ]:         73 :         if (pctrlr->pmr.mem_register_addr) {
     583                 :          0 :                 spdk_mem_unregister(pctrlr->pmr.mem_register_addr, pctrlr->pmr.mem_register_size);
     584                 :            :         }
     585                 :            : 
     586         [ -  + ]:         73 :         if (nvme_pcie_ctrlr_get_pmrcap(pctrlr, &pmrcap)) {
     587                 :          0 :                 SPDK_ERRLOG("get_pmrcap() failed\n");
     588                 :          0 :                 return -EIO;
     589                 :            :         }
     590                 :            : 
     591         [ +  - ]:         73 :         if (pmrcap.bits.cmss) {
     592         [ -  + ]:         73 :                 if (nvme_pcie_ctrlr_set_pmrmscu(pctrlr, 0)) {
     593                 :          0 :                         SPDK_ERRLOG("set_pmrmscu() failed\n");
     594                 :            :                 }
     595                 :            : 
     596         [ -  + ]:         73 :                 if (nvme_pcie_ctrlr_set_pmrmscl(pctrlr, 0)) {
     597                 :          0 :                         SPDK_ERRLOG("set_pmrmscl() failed\n");
     598                 :            :                 }
     599                 :            :         }
     600                 :            : 
     601                 :         73 :         rc = spdk_pci_device_unmap_bar(pctrlr->devhandle, pmrcap.bits.bir, addr);
     602                 :            : 
     603                 :         73 :         return rc;
     604                 :            : }
     605                 :            : 
     606                 :            : static int
     607                 :        100 : nvme_pcie_ctrlr_config_pmr(struct spdk_nvme_ctrlr *ctrlr, bool enable)
     608                 :            : {
     609                 :        100 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     610                 :         12 :         union spdk_nvme_pmrcap_register pmrcap;
     611                 :         12 :         union spdk_nvme_pmrctl_register pmrctl;
     612                 :         12 :         union spdk_nvme_pmrsts_register pmrsts;
     613                 :            :         uint8_t pmrto, pmrtu;
     614                 :            :         uint64_t timeout_in_ms, ticks_per_ms, timeout_in_ticks, now_ticks;
     615                 :            : 
     616         [ -  + ]:        100 :         if (!pctrlr->regs->cap.bits.pmrs) {
     617                 :          0 :                 SPDK_ERRLOG("PMR is not supported by the controller\n");
     618                 :          0 :                 return -ENOTSUP;
     619                 :            :         }
     620                 :            : 
     621         [ -  + ]:        100 :         if (nvme_pcie_ctrlr_get_pmrcap(pctrlr, &pmrcap)) {
     622                 :          0 :                 SPDK_ERRLOG("get registers failed\n");
     623                 :          0 :                 return -EIO;
     624                 :            :         }
     625                 :            : 
     626                 :        100 :         pmrto = pmrcap.bits.pmrto;
     627                 :        100 :         pmrtu = pmrcap.bits.pmrtu;
     628                 :            : 
     629         [ -  + ]:        100 :         if (pmrtu > 1) {
     630                 :          0 :                 SPDK_ERRLOG("PMR Time Units Invalid\n");
     631                 :          0 :                 return -EINVAL;
     632                 :            :         }
     633                 :            : 
     634                 :        100 :         ticks_per_ms = spdk_get_ticks_hz() / 1000;
     635         [ -  + ]:        100 :         timeout_in_ms = pmrto * (pmrtu ? (60 * 1000) : 500);
     636                 :        100 :         timeout_in_ticks = timeout_in_ms * ticks_per_ms;
     637                 :            : 
     638         [ -  + ]:        100 :         if (nvme_pcie_ctrlr_get_pmrctl(pctrlr, &pmrctl)) {
     639                 :          0 :                 SPDK_ERRLOG("get pmrctl failed\n");
     640                 :          0 :                 return -EIO;
     641                 :            :         }
     642                 :            : 
     643   [ +  +  -  + ]:        100 :         if (enable && pmrctl.bits.en != 0) {
     644                 :          0 :                 SPDK_ERRLOG("PMR is already enabled\n");
     645                 :          0 :                 return -EINVAL;
     646   [ +  +  +  + ]:        100 :         } else if (!enable && pmrctl.bits.en != 1) {
     647                 :          4 :                 SPDK_ERRLOG("PMR is already disabled\n");
     648                 :          4 :                 return -EINVAL;
     649                 :            :         }
     650                 :            : 
     651                 :         96 :         pmrctl.bits.en = enable;
     652                 :            : 
     653         [ -  + ]:         96 :         if (nvme_pcie_ctrlr_set_pmrctl(pctrlr, &pmrctl)) {
     654                 :          0 :                 SPDK_ERRLOG("set pmrctl failed\n");
     655                 :          0 :                 return -EIO;
     656                 :            :         }
     657                 :            : 
     658                 :         96 :         now_ticks =  spdk_get_ticks();
     659                 :            : 
     660                 :            :         do {
     661         [ -  + ]:         96 :                 if (nvme_pcie_ctrlr_get_pmrsts(pctrlr, &pmrsts)) {
     662                 :          0 :                         SPDK_ERRLOG("get pmrsts failed\n");
     663                 :          0 :                         return -EIO;
     664                 :            :                 }
     665                 :            : 
     666         [ -  + ]:         96 :                 if (pmrsts.bits.nrdy == enable &&
     667         [ #  # ]:          0 :                     spdk_get_ticks() > now_ticks + timeout_in_ticks) {
     668                 :          0 :                         SPDK_ERRLOG("PMR Enable - Timed Out\n");
     669                 :          0 :                         return -ETIMEDOUT;
     670                 :            :                 }
     671         [ -  + ]:         96 :         } while (pmrsts.bits.nrdy == enable);
     672                 :            : 
     673   [ -  +  -  +  :         96 :         SPDK_DEBUGLOG(nvme, "PMR %s\n", enable ? "Enabled" : "Disabled");
                   -  - ]
     674                 :            : 
     675                 :         96 :         return 0;
     676                 :            : }
     677                 :            : 
     678                 :            : static int
     679                 :         44 : nvme_pcie_ctrlr_enable_pmr(struct spdk_nvme_ctrlr *ctrlr)
     680                 :            : {
     681                 :         44 :         return nvme_pcie_ctrlr_config_pmr(ctrlr, true);
     682                 :            : }
     683                 :            : 
     684                 :            : static int
     685                 :         44 : nvme_pcie_ctrlr_disable_pmr(struct spdk_nvme_ctrlr *ctrlr)
     686                 :            : {
     687                 :         44 :         return nvme_pcie_ctrlr_config_pmr(ctrlr, false);
     688                 :            : }
     689                 :            : 
     690                 :            : static void *
     691                 :         68 : nvme_pcie_ctrlr_map_io_pmr(struct spdk_nvme_ctrlr *ctrlr, size_t *size)
     692                 :            : {
     693                 :         68 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     694                 :         24 :         union spdk_nvme_pmrcap_register pmrcap;
     695                 :            :         uint64_t mem_register_start, mem_register_end;
     696                 :            :         int rc;
     697                 :            : 
     698         [ +  + ]:         68 :         if (!pctrlr->regs->cap.bits.pmrs) {
     699                 :          4 :                 SPDK_ERRLOG("PMR is not supported by the controller\n");
     700                 :          4 :                 return NULL;
     701                 :            :         }
     702                 :            : 
     703         [ +  + ]:         64 :         if (pctrlr->pmr.mem_register_addr != NULL) {
     704                 :          4 :                 *size = pctrlr->pmr.mem_register_size;
     705                 :          4 :                 return pctrlr->pmr.mem_register_addr;
     706                 :            :         }
     707                 :            : 
     708                 :         60 :         *size = 0;
     709                 :            : 
     710         [ +  + ]:         60 :         if (pctrlr->pmr.bar_va == NULL) {
     711   [ -  +  -  + ]:          4 :                 SPDK_DEBUGLOG(nvme, "PMR not available\n");
     712                 :          4 :                 return NULL;
     713                 :            :         }
     714                 :            : 
     715         [ -  + ]:         56 :         if (nvme_pcie_ctrlr_get_pmrcap(pctrlr, &pmrcap)) {
     716                 :          0 :                 SPDK_ERRLOG("get registers failed\n");
     717                 :          0 :                 return NULL;
     718                 :            :         }
     719                 :            : 
     720                 :            :         /* Check if WDS / RDS is supported */
     721   [ +  +  +  - ]:         56 :         if (!(pmrcap.bits.wds || pmrcap.bits.rds)) {
     722                 :          4 :                 return NULL;
     723                 :            :         }
     724                 :            : 
     725                 :            :         /* If PMR is less than 4MiB in size then abort PMR mapping */
     726         [ +  + ]:         52 :         if (pctrlr->pmr.size < (1ULL << 22)) {
     727                 :          4 :                 return NULL;
     728                 :            :         }
     729                 :            : 
     730                 :         48 :         mem_register_start = _2MB_PAGE((uintptr_t)pctrlr->pmr.bar_va + VALUE_2MB - 1);
     731                 :         48 :         mem_register_end = _2MB_PAGE((uintptr_t)pctrlr->pmr.bar_va + pctrlr->pmr.size);
     732                 :            : 
     733                 :         48 :         rc = spdk_mem_register((void *)mem_register_start, mem_register_end - mem_register_start);
     734         [ -  + ]:         48 :         if (rc) {
     735                 :          0 :                 SPDK_ERRLOG("spdk_mem_register() failed\n");
     736                 :          0 :                 return NULL;
     737                 :            :         }
     738                 :            : 
     739                 :         48 :         pctrlr->pmr.mem_register_addr = (void *)mem_register_start;
     740                 :         48 :         pctrlr->pmr.mem_register_size = mem_register_end - mem_register_start;
     741                 :            : 
     742                 :         48 :         *size = pctrlr->pmr.mem_register_size;
     743                 :         48 :         return pctrlr->pmr.mem_register_addr;
     744                 :            : }
     745                 :            : 
     746                 :            : static int
     747                 :         44 : nvme_pcie_ctrlr_unmap_io_pmr(struct spdk_nvme_ctrlr *ctrlr)
     748                 :            : {
     749                 :         44 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     750                 :            :         int rc;
     751                 :            : 
     752         [ -  + ]:         44 :         if (pctrlr->pmr.mem_register_addr == NULL) {
     753                 :          0 :                 return -ENXIO;
     754                 :            :         }
     755                 :            : 
     756                 :         44 :         rc = spdk_mem_unregister(pctrlr->pmr.mem_register_addr, pctrlr->pmr.mem_register_size);
     757                 :            : 
     758         [ +  - ]:         44 :         if (rc == 0) {
     759                 :         44 :                 pctrlr->pmr.mem_register_addr = NULL;
     760                 :         44 :                 pctrlr->pmr.mem_register_size = 0;
     761                 :            :         }
     762                 :            : 
     763                 :         44 :         return rc;
     764                 :            : }
     765                 :            : 
     766                 :            : static int
     767                 :        655 : nvme_pcie_ctrlr_allocate_bars(struct nvme_pcie_ctrlr *pctrlr)
     768                 :            : {
     769                 :            :         int rc;
     770                 :        655 :         void *addr = NULL;
     771                 :        655 :         uint64_t phys_addr = 0, size = 0;
     772                 :            : 
     773                 :        655 :         rc = spdk_pci_device_map_bar(pctrlr->devhandle, 0, &addr,
     774                 :            :                                      &phys_addr, &size);
     775                 :            : 
     776   [ +  -  -  + ]:        655 :         if ((addr == NULL) || (rc != 0)) {
     777                 :          0 :                 SPDK_ERRLOG("nvme_pcicfg_map_bar failed with rc %d or bar %p\n",
     778                 :            :                             rc, addr);
     779                 :          0 :                 return -1;
     780                 :            :         }
     781                 :            : 
     782                 :        655 :         pctrlr->regs = (volatile struct spdk_nvme_registers *)addr;
     783                 :        655 :         pctrlr->regs_size = size;
     784                 :        655 :         pctrlr->doorbell_base = (volatile uint32_t *)&pctrlr->regs->doorbell[0].sq_tdbl;
     785                 :        655 :         nvme_pcie_ctrlr_map_cmb(pctrlr);
     786                 :        655 :         nvme_pcie_ctrlr_map_pmr(pctrlr);
     787                 :            : 
     788                 :        655 :         return 0;
     789                 :            : }
     790                 :            : 
     791                 :            : static int
     792                 :        651 : nvme_pcie_ctrlr_free_bars(struct nvme_pcie_ctrlr *pctrlr)
     793                 :            : {
     794                 :        651 :         int rc = 0;
     795                 :        651 :         void *addr = (void *)pctrlr->regs;
     796                 :            : 
     797   [ +  +  +  + ]:        651 :         if (pctrlr->ctrlr.is_removed) {
     798                 :         63 :                 return rc;
     799                 :            :         }
     800                 :            : 
     801                 :        588 :         rc = nvme_pcie_ctrlr_unmap_pmr(pctrlr);
     802         [ -  + ]:        588 :         if (rc != 0) {
     803                 :          0 :                 SPDK_ERRLOG("nvme_ctrlr_unmap_pmr failed with error code %d\n", rc);
     804                 :          0 :                 return -1;
     805                 :            :         }
     806                 :            : 
     807                 :        588 :         rc = nvme_pcie_ctrlr_unmap_cmb(pctrlr);
     808         [ -  + ]:        588 :         if (rc != 0) {
     809                 :          0 :                 SPDK_ERRLOG("nvme_ctrlr_unmap_cmb failed with error code %d\n", rc);
     810                 :          0 :                 return -1;
     811                 :            :         }
     812                 :            : 
     813   [ +  -  +  - ]:        588 :         if (addr && spdk_process_is_primary()) {
     814                 :            :                 /* NOTE: addr may have been remapped here. We're relying on DPDK to call
     815                 :            :                  * munmap internally.
     816                 :            :                  */
     817                 :        588 :                 rc = spdk_pci_device_unmap_bar(pctrlr->devhandle, 0, addr);
     818                 :            :         }
     819                 :        588 :         return rc;
     820                 :            : }
     821                 :            : 
     822                 :            : /* This function must only be called while holding g_spdk_nvme_driver->lock */
     823                 :            : static int
     824                 :        888 : pcie_nvme_enum_cb(void *ctx, struct spdk_pci_device *pci_dev)
     825                 :            : {
     826                 :        888 :         struct spdk_nvme_transport_id trid = {};
     827                 :        888 :         struct nvme_pcie_enum_ctx *enum_ctx = ctx;
     828                 :            :         struct spdk_nvme_ctrlr *ctrlr;
     829                 :        520 :         struct spdk_pci_addr pci_addr;
     830                 :            : 
     831                 :        888 :         pci_addr = spdk_pci_device_get_addr(pci_dev);
     832                 :            : 
     833                 :        888 :         spdk_nvme_trid_populate_transport(&trid, SPDK_NVME_TRANSPORT_PCIE);
     834                 :        888 :         spdk_pci_addr_fmt(trid.traddr, sizeof(trid.traddr), &pci_addr);
     835                 :            : 
     836                 :        888 :         ctrlr = nvme_get_ctrlr_by_trid_unsafe(&trid, NULL);
     837         [ +  + ]:        888 :         if (!spdk_process_is_primary()) {
     838         [ -  + ]:        211 :                 if (!ctrlr) {
     839                 :          0 :                         SPDK_ERRLOG("Controller must be constructed in the primary process first.\n");
     840                 :          0 :                         return -1;
     841                 :            :                 }
     842                 :            : 
     843                 :        211 :                 return nvme_ctrlr_add_process(ctrlr, pci_dev);
     844                 :            :         }
     845                 :            : 
     846                 :            :         /* check whether user passes the pci_addr */
     847   [ +  +  +  +  :       1191 :         if (enum_ctx->has_pci_addr &&
                   -  + ]
     848                 :        514 :             (spdk_pci_addr_compare(&pci_addr, &enum_ctx->pci_addr) != 0)) {
     849                 :          0 :                 return 1;
     850                 :            :         }
     851                 :            : 
     852                 :        677 :         return nvme_ctrlr_probe(&trid, enum_ctx->probe_ctx, pci_dev);
     853                 :            : }
     854                 :            : 
     855                 :            : static int
     856                 :      84646 : nvme_pcie_ctrlr_scan(struct spdk_nvme_probe_ctx *probe_ctx,
     857                 :            :                      bool direct_connect)
     858                 :            : {
     859                 :      84646 :         struct nvme_pcie_enum_ctx enum_ctx = {};
     860                 :            : 
     861                 :      84646 :         enum_ctx.probe_ctx = probe_ctx;
     862                 :            : 
     863         [ +  + ]:      84646 :         if (strlen(probe_ctx->trid.traddr) != 0) {
     864         [ -  + ]:        536 :                 if (spdk_pci_addr_parse(&enum_ctx.pci_addr, probe_ctx->trid.traddr)) {
     865                 :          0 :                         return -1;
     866                 :            :                 }
     867                 :        536 :                 enum_ctx.has_pci_addr = true;
     868                 :            :         }
     869                 :            : 
     870                 :            :         /* Only the primary process can monitor hotplug. */
     871         [ +  + ]:      84646 :         if (spdk_process_is_primary()) {
     872         [ -  + ]:      84519 :                 if (_nvme_pcie_hotplug_monitor(probe_ctx) > 0) {
     873                 :            :                         /* Some removal events were received. Return immediately, avoiding
     874                 :            :                          * an spdk_pci_enumerate() which could trigger issue #3205.
     875                 :            :                          */
     876                 :          0 :                         return 0;
     877                 :            :                 }
     878                 :            :         }
     879                 :            : 
     880   [ +  +  +  + ]:      84646 :         if (enum_ctx.has_pci_addr == false) {
     881                 :      84110 :                 return spdk_pci_enumerate(spdk_pci_nvme_get_driver(),
     882                 :            :                                           pcie_nvme_enum_cb, &enum_ctx);
     883                 :            :         } else {
     884                 :        536 :                 return spdk_pci_device_attach(spdk_pci_nvme_get_driver(),
     885                 :            :                                               pcie_nvme_enum_cb, &enum_ctx, &enum_ctx.pci_addr);
     886                 :            :         }
     887                 :            : }
     888                 :            : 
     889                 :            : static struct spdk_nvme_ctrlr *
     890                 :        655 :         nvme_pcie_ctrlr_construct(const struct spdk_nvme_transport_id *trid,
     891                 :            :                           const struct spdk_nvme_ctrlr_opts *opts,
     892                 :            :                           void *devhandle)
     893                 :            : {
     894                 :        655 :         struct spdk_pci_device *pci_dev = devhandle;
     895                 :            :         struct nvme_pcie_ctrlr *pctrlr;
     896                 :        382 :         union spdk_nvme_cap_register cap;
     897                 :        382 :         uint16_t cmd_reg;
     898                 :            :         int rc;
     899                 :        382 :         struct spdk_pci_id pci_id;
     900                 :            : 
     901                 :        655 :         rc = spdk_pci_device_claim(pci_dev);
     902         [ -  + ]:        655 :         if (rc < 0) {
     903                 :          0 :                 SPDK_ERRLOG("could not claim device %s (%s)\n",
     904                 :            :                             trid->traddr, spdk_strerror(-rc));
     905                 :          0 :                 return NULL;
     906                 :            :         }
     907                 :            : 
     908                 :        655 :         pctrlr = spdk_zmalloc(sizeof(struct nvme_pcie_ctrlr), 64, NULL,
     909                 :            :                               SPDK_ENV_SOCKET_ID_ANY, SPDK_MALLOC_SHARE);
     910         [ -  + ]:        655 :         if (pctrlr == NULL) {
     911                 :          0 :                 spdk_pci_device_unclaim(pci_dev);
     912                 :          0 :                 SPDK_ERRLOG("could not allocate ctrlr\n");
     913                 :          0 :                 return NULL;
     914                 :            :         }
     915                 :            : 
     916                 :        655 :         pctrlr->is_remapped = false;
     917                 :        655 :         pctrlr->ctrlr.is_removed = false;
     918                 :        655 :         pctrlr->devhandle = devhandle;
     919                 :        655 :         pctrlr->ctrlr.opts = *opts;
     920                 :        655 :         pctrlr->ctrlr.trid = *trid;
     921                 :        655 :         pctrlr->ctrlr.opts.admin_queue_size = spdk_max(pctrlr->ctrlr.opts.admin_queue_size,
     922                 :            :                                               NVME_PCIE_MIN_ADMIN_QUEUE_SIZE);
     923                 :        655 :         pci_id = spdk_pci_device_get_id(pci_dev);
     924                 :        655 :         pctrlr->ctrlr.quirks = nvme_get_quirks(&pci_id);
     925         [ +  + ]:        655 :         if (pci_dev->socket_id != SPDK_ENV_SOCKET_ID_ANY) {
     926                 :        116 :                 pctrlr->ctrlr.socket_id_valid = true;
     927                 :        116 :                 pctrlr->ctrlr.socket_id = pci_dev->socket_id;
     928                 :            :         }
     929                 :            : 
     930                 :        655 :         rc = nvme_ctrlr_construct(&pctrlr->ctrlr);
     931         [ -  + ]:        655 :         if (rc != 0) {
     932                 :          0 :                 spdk_pci_device_unclaim(pci_dev);
     933                 :          0 :                 spdk_free(pctrlr);
     934                 :          0 :                 return NULL;
     935                 :            :         }
     936                 :            : 
     937                 :        655 :         rc = nvme_pcie_ctrlr_allocate_bars(pctrlr);
     938         [ -  + ]:        655 :         if (rc != 0) {
     939                 :          0 :                 spdk_pci_device_unclaim(pci_dev);
     940                 :          0 :                 spdk_free(pctrlr);
     941                 :          0 :                 return NULL;
     942                 :            :         }
     943                 :            : 
     944                 :            :         /* Enable PCI busmaster and disable INTx */
     945                 :        655 :         spdk_pci_device_cfg_read16(pci_dev, &cmd_reg, 4);
     946                 :        655 :         cmd_reg |= 0x404;
     947                 :        655 :         spdk_pci_device_cfg_write16(pci_dev, cmd_reg, 4);
     948                 :            : 
     949         [ -  + ]:        655 :         if (nvme_ctrlr_get_cap(&pctrlr->ctrlr, &cap)) {
     950                 :          0 :                 SPDK_ERRLOG("get_cap() failed\n");
     951                 :          0 :                 spdk_pci_device_unclaim(pci_dev);
     952                 :          0 :                 spdk_free(pctrlr);
     953                 :          0 :                 return NULL;
     954                 :            :         }
     955                 :            : 
     956                 :            :         /* Doorbell stride is 2 ^ (dstrd + 2),
     957                 :            :          * but we want multiples of 4, so drop the + 2 */
     958         [ -  + ]:        655 :         pctrlr->doorbell_stride_u32 = 1 << cap.bits.dstrd;
     959                 :            : 
     960                 :        655 :         rc = nvme_pcie_ctrlr_construct_admin_qpair(&pctrlr->ctrlr, pctrlr->ctrlr.opts.admin_queue_size);
     961         [ -  + ]:        655 :         if (rc != 0) {
     962                 :          0 :                 nvme_ctrlr_destruct(&pctrlr->ctrlr);
     963                 :          0 :                 return NULL;
     964                 :            :         }
     965                 :            : 
     966                 :            :         /* Construct the primary process properties */
     967                 :        655 :         rc = nvme_ctrlr_add_process(&pctrlr->ctrlr, pci_dev);
     968         [ -  + ]:        655 :         if (rc != 0) {
     969                 :          0 :                 nvme_ctrlr_destruct(&pctrlr->ctrlr);
     970                 :          0 :                 return NULL;
     971                 :            :         }
     972                 :            : 
     973   [ +  +  +  + ]:        655 :         if (g_sigset != true) {
     974                 :        455 :                 spdk_pci_register_error_handler(nvme_sigbus_fault_sighandler,
     975                 :            :                                                 NULL);
     976                 :        455 :                 g_sigset = true;
     977                 :            :         }
     978                 :            : 
     979                 :        655 :         return &pctrlr->ctrlr;
     980                 :            : }
     981                 :            : 
     982                 :            : static int
     983                 :        727 : nvme_pcie_ctrlr_enable(struct spdk_nvme_ctrlr *ctrlr)
     984                 :            : {
     985                 :        727 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
     986                 :        727 :         struct nvme_pcie_qpair *padminq = nvme_pcie_qpair(ctrlr->adminq);
     987                 :        416 :         union spdk_nvme_aqa_register aqa;
     988                 :            : 
     989         [ -  + ]:        727 :         if (nvme_pcie_ctrlr_set_asq(pctrlr, padminq->cmd_bus_addr)) {
     990                 :          0 :                 SPDK_ERRLOG("set_asq() failed\n");
     991                 :          0 :                 return -EIO;
     992                 :            :         }
     993                 :            : 
     994         [ -  + ]:        727 :         if (nvme_pcie_ctrlr_set_acq(pctrlr, padminq->cpl_bus_addr)) {
     995                 :          0 :                 SPDK_ERRLOG("set_acq() failed\n");
     996                 :          0 :                 return -EIO;
     997                 :            :         }
     998                 :            : 
     999                 :        727 :         aqa.raw = 0;
    1000                 :            :         /* acqs and asqs are 0-based. */
    1001                 :        727 :         aqa.bits.acqs = nvme_pcie_qpair(ctrlr->adminq)->num_entries - 1;
    1002                 :        727 :         aqa.bits.asqs = nvme_pcie_qpair(ctrlr->adminq)->num_entries - 1;
    1003                 :            : 
    1004         [ -  + ]:        727 :         if (nvme_pcie_ctrlr_set_aqa(pctrlr, &aqa)) {
    1005                 :          0 :                 SPDK_ERRLOG("set_aqa() failed\n");
    1006                 :          0 :                 return -EIO;
    1007                 :            :         }
    1008                 :            : 
    1009                 :        727 :         return 0;
    1010                 :            : }
    1011                 :            : 
    1012                 :            : static int
    1013                 :        651 : nvme_pcie_ctrlr_destruct(struct spdk_nvme_ctrlr *ctrlr)
    1014                 :            : {
    1015                 :        651 :         struct nvme_pcie_ctrlr *pctrlr = nvme_pcie_ctrlr(ctrlr);
    1016                 :        651 :         struct spdk_pci_device *devhandle = nvme_ctrlr_proc_get_devhandle(ctrlr);
    1017                 :            : 
    1018         [ +  - ]:        651 :         if (ctrlr->adminq) {
    1019                 :        651 :                 nvme_pcie_qpair_destroy(ctrlr->adminq);
    1020                 :            :         }
    1021                 :            : 
    1022                 :        651 :         nvme_ctrlr_destruct_finish(ctrlr);
    1023                 :            : 
    1024                 :        651 :         nvme_pcie_ctrlr_free_bars(pctrlr);
    1025                 :            : 
    1026         [ +  - ]:        651 :         if (devhandle) {
    1027                 :        651 :                 spdk_pci_device_unclaim(devhandle);
    1028                 :        651 :                 spdk_pci_device_detach(devhandle);
    1029                 :            :         }
    1030                 :            : 
    1031                 :        651 :         spdk_free(pctrlr);
    1032                 :            : 
    1033                 :        651 :         return 0;
    1034                 :            : }
    1035                 :            : 
    1036                 :            : static int
    1037                 :       7218 : nvme_pcie_qpair_iterate_requests(struct spdk_nvme_qpair *qpair,
    1038                 :            :                                  int (*iter_fn)(struct nvme_request *req, void *arg),
    1039                 :            :                                  void *arg)
    1040                 :            : {
    1041                 :       7218 :         struct nvme_pcie_qpair *pqpair = nvme_pcie_qpair(qpair);
    1042                 :            :         struct nvme_tracker *tr, *tmp;
    1043                 :            :         int rc;
    1044                 :            : 
    1045         [ -  + ]:       7218 :         assert(iter_fn != NULL);
    1046                 :            : 
    1047         [ +  + ]:     123387 :         TAILQ_FOREACH_SAFE(tr, &pqpair->outstanding_tr, tq_list, tmp) {
    1048         [ -  + ]:     116169 :                 assert(tr->req != NULL);
    1049                 :            : 
    1050                 :     116169 :                 rc = iter_fn(tr->req, arg);
    1051         [ -  + ]:     116169 :                 if (rc != 0) {
    1052                 :          0 :                         return rc;
    1053                 :            :                 }
    1054                 :            :         }
    1055                 :            : 
    1056                 :       7218 :         return 0;
    1057                 :            : }
    1058                 :            : 
    1059                 :            : void
    1060                 :          0 : spdk_nvme_pcie_set_hotplug_filter(spdk_nvme_pcie_hotplug_filter_cb filter_cb)
    1061                 :            : {
    1062                 :          0 :         g_hotplug_filter_cb = filter_cb;
    1063                 :          0 : }
    1064                 :            : 
    1065                 :            : static struct spdk_pci_id nvme_pci_driver_id[] = {
    1066                 :            :         {
    1067                 :            :                 .class_id = SPDK_PCI_CLASS_NVME,
    1068                 :            :                 .vendor_id = SPDK_PCI_ANY_ID,
    1069                 :            :                 .device_id = SPDK_PCI_ANY_ID,
    1070                 :            :                 .subvendor_id = SPDK_PCI_ANY_ID,
    1071                 :            :                 .subdevice_id = SPDK_PCI_ANY_ID,
    1072                 :            :         },
    1073                 :            :         { .vendor_id = 0, /* sentinel */ },
    1074                 :            : };
    1075                 :            : 
    1076                 :       2594 : SPDK_PCI_DRIVER_REGISTER(nvme, nvme_pci_driver_id,
    1077                 :            :                          SPDK_PCI_DRIVER_NEED_MAPPING | SPDK_PCI_DRIVER_WC_ACTIVATE);
    1078                 :            : 
    1079                 :            : const struct spdk_nvme_transport_ops pcie_ops = {
    1080                 :            :         .name = "PCIE",
    1081                 :            :         .type = SPDK_NVME_TRANSPORT_PCIE,
    1082                 :            :         .ctrlr_construct = nvme_pcie_ctrlr_construct,
    1083                 :            :         .ctrlr_scan = nvme_pcie_ctrlr_scan,
    1084                 :            :         .ctrlr_destruct = nvme_pcie_ctrlr_destruct,
    1085                 :            :         .ctrlr_enable = nvme_pcie_ctrlr_enable,
    1086                 :            : 
    1087                 :            :         .ctrlr_get_registers = nvme_pcie_ctrlr_get_registers,
    1088                 :            :         .ctrlr_set_reg_4 = nvme_pcie_ctrlr_set_reg_4,
    1089                 :            :         .ctrlr_set_reg_8 = nvme_pcie_ctrlr_set_reg_8,
    1090                 :            :         .ctrlr_get_reg_4 = nvme_pcie_ctrlr_get_reg_4,
    1091                 :            :         .ctrlr_get_reg_8 = nvme_pcie_ctrlr_get_reg_8,
    1092                 :            : 
    1093                 :            :         .ctrlr_get_max_xfer_size = nvme_pcie_ctrlr_get_max_xfer_size,
    1094                 :            :         .ctrlr_get_max_sges = nvme_pcie_ctrlr_get_max_sges,
    1095                 :            : 
    1096                 :            :         .ctrlr_reserve_cmb = nvme_pcie_ctrlr_reserve_cmb,
    1097                 :            :         .ctrlr_map_cmb = nvme_pcie_ctrlr_map_io_cmb,
    1098                 :            :         .ctrlr_unmap_cmb = nvme_pcie_ctrlr_unmap_io_cmb,
    1099                 :            : 
    1100                 :            :         .ctrlr_enable_pmr = nvme_pcie_ctrlr_enable_pmr,
    1101                 :            :         .ctrlr_disable_pmr = nvme_pcie_ctrlr_disable_pmr,
    1102                 :            :         .ctrlr_map_pmr = nvme_pcie_ctrlr_map_io_pmr,
    1103                 :            :         .ctrlr_unmap_pmr = nvme_pcie_ctrlr_unmap_io_pmr,
    1104                 :            : 
    1105                 :            :         .ctrlr_create_io_qpair = nvme_pcie_ctrlr_create_io_qpair,
    1106                 :            :         .ctrlr_delete_io_qpair = nvme_pcie_ctrlr_delete_io_qpair,
    1107                 :            :         .ctrlr_connect_qpair = nvme_pcie_ctrlr_connect_qpair,
    1108                 :            :         .ctrlr_disconnect_qpair = nvme_pcie_ctrlr_disconnect_qpair,
    1109                 :            : 
    1110                 :            :         .qpair_abort_reqs = nvme_pcie_qpair_abort_reqs,
    1111                 :            :         .qpair_reset = nvme_pcie_qpair_reset,
    1112                 :            :         .qpair_submit_request = nvme_pcie_qpair_submit_request,
    1113                 :            :         .qpair_process_completions = nvme_pcie_qpair_process_completions,
    1114                 :            :         .qpair_iterate_requests = nvme_pcie_qpair_iterate_requests,
    1115                 :            :         .admin_qpair_abort_aers = nvme_pcie_admin_qpair_abort_aers,
    1116                 :            : 
    1117                 :            :         .poll_group_create = nvme_pcie_poll_group_create,
    1118                 :            :         .poll_group_connect_qpair = nvme_pcie_poll_group_connect_qpair,
    1119                 :            :         .poll_group_disconnect_qpair = nvme_pcie_poll_group_disconnect_qpair,
    1120                 :            :         .poll_group_add = nvme_pcie_poll_group_add,
    1121                 :            :         .poll_group_remove = nvme_pcie_poll_group_remove,
    1122                 :            :         .poll_group_process_completions = nvme_pcie_poll_group_process_completions,
    1123                 :            :         .poll_group_destroy = nvme_pcie_poll_group_destroy,
    1124                 :            :         .poll_group_get_stats = nvme_pcie_poll_group_get_stats,
    1125                 :            :         .poll_group_free_stats = nvme_pcie_poll_group_free_stats
    1126                 :            : };
    1127                 :            : 
    1128                 :       2594 : SPDK_NVME_TRANSPORT_REGISTER(pcie, &pcie_ops);

Generated by: LCOV version 1.14