LCOV - code coverage report
Current view: top level - lib/ftl - ftl_io.c (source / functions) Hit Total Coverage
Test: ut_cov_unit.info Lines: 25 126 19.8 %
Date: 2024-12-15 17:30:36 Functions: 4 15 26.7 %

          Line data    Source code
       1             : /*   SPDX-License-Identifier: BSD-3-Clause
       2             :  *   Copyright (C) 2018 Intel Corporation.
       3             :  *   All rights reserved.
       4             :  */
       5             : 
       6             : #include "spdk/stdinc.h"
       7             : #include "spdk/ftl.h"
       8             : #include "spdk/likely.h"
       9             : #include "spdk/util.h"
      10             : 
      11             : #include "ftl_io.h"
      12             : #include "ftl_core.h"
      13             : #include "ftl_band.h"
      14             : #include "ftl_debug.h"
      15             : 
      16             : void
      17          16 : ftl_io_inc_req(struct ftl_io *io)
      18             : {
      19          16 :         io->dev->num_inflight++;
      20          16 :         io->req_cnt++;
      21          16 : }
      22             : 
      23             : void
      24          16 : ftl_io_dec_req(struct ftl_io *io)
      25             : {
      26          16 :         assert(io->dev->num_inflight > 0);
      27          16 :         assert(io->req_cnt > 0);
      28             : 
      29          16 :         io->dev->num_inflight--;
      30          16 :         io->req_cnt--;
      31          16 : }
      32             : 
      33             : struct iovec *
      34           0 : ftl_io_iovec(struct ftl_io *io)
      35             : {
      36           0 :         return &io->iov[0];
      37             : }
      38             : 
      39             : uint64_t
      40           0 : ftl_io_get_lba(const struct ftl_io *io, size_t offset)
      41             : {
      42           0 :         assert(offset < io->num_blocks);
      43           0 :         return io->lba + offset;
      44             : }
      45             : 
      46             : uint64_t
      47           0 : ftl_io_current_lba(const struct ftl_io *io)
      48             : {
      49           0 :         return ftl_io_get_lba(io, io->pos);
      50             : }
      51             : 
      52             : void
      53           0 : ftl_io_advance(struct ftl_io *io, size_t num_blocks)
      54             : {
      55           0 :         struct iovec *iov = ftl_io_iovec(io);
      56           0 :         size_t iov_blocks, block_left = num_blocks;
      57             : 
      58           0 :         io->pos += num_blocks;
      59             : 
      60           0 :         if (io->iov_cnt == 0) {
      61           0 :                 return;
      62             :         }
      63             : 
      64           0 :         while (block_left > 0) {
      65           0 :                 assert(io->iov_pos < io->iov_cnt);
      66           0 :                 iov_blocks = iov[io->iov_pos].iov_len / FTL_BLOCK_SIZE;
      67             : 
      68           0 :                 if (io->iov_off + block_left < iov_blocks) {
      69           0 :                         io->iov_off += block_left;
      70           0 :                         break;
      71             :                 }
      72             : 
      73           0 :                 assert(iov_blocks > io->iov_off);
      74           0 :                 block_left -= (iov_blocks - io->iov_off);
      75           0 :                 io->iov_off = 0;
      76           0 :                 io->iov_pos++;
      77             :         }
      78             : }
      79             : 
      80             : size_t
      81           0 : ftl_iovec_num_blocks(struct iovec *iov, size_t iov_cnt)
      82             : {
      83           0 :         size_t num_blocks = 0, i = 0;
      84             : 
      85           0 :         for (; i < iov_cnt; ++i) {
      86           0 :                 if (iov[i].iov_len & (FTL_BLOCK_SIZE - 1)) {
      87           0 :                         return 0;
      88             :                 }
      89             : 
      90           0 :                 num_blocks += iov[i].iov_len / FTL_BLOCK_SIZE;
      91             :         }
      92             : 
      93           0 :         return num_blocks;
      94             : }
      95             : 
      96             : void *
      97           0 : ftl_io_iovec_addr(struct ftl_io *io)
      98             : {
      99           0 :         assert(io->iov_pos < io->iov_cnt);
     100           0 :         assert(io->iov_off * FTL_BLOCK_SIZE < ftl_io_iovec(io)[io->iov_pos].iov_len);
     101             : 
     102           0 :         return (char *)ftl_io_iovec(io)[io->iov_pos].iov_base +
     103           0 :                io->iov_off * FTL_BLOCK_SIZE;
     104             : }
     105             : 
     106             : size_t
     107           0 : ftl_io_iovec_len_left(struct ftl_io *io)
     108             : {
     109           0 :         if (io->iov_pos < io->iov_cnt) {
     110           0 :                 struct iovec *iov = ftl_io_iovec(io);
     111           0 :                 return iov[io->iov_pos].iov_len / FTL_BLOCK_SIZE - io->iov_off;
     112             :         } else {
     113           0 :                 return 0;
     114             :         }
     115             : }
     116             : 
     117             : static void
     118           3 : ftl_io_cb(struct ftl_io *io, void *arg, int status)
     119             : {
     120           3 :         struct ftl_io_channel *ioch = ftl_io_channel_get_ctx(io->ioch);
     121             :         size_t result  __attribute__((unused));
     122             : 
     123           3 :         if (spdk_unlikely(status)) {
     124           1 :                 io->status = status;
     125             : 
     126           1 :                 if (-EAGAIN == status) {
     127             :                         /* IO has to be rescheduled again */
     128           0 :                         switch (io->type) {
     129           0 :                         case FTL_IO_READ:
     130           0 :                                 ftl_io_clear(io);
     131           0 :                                 TAILQ_INSERT_HEAD(&io->dev->rd_sq, io, queue_entry);
     132           0 :                                 break;
     133           0 :                         case FTL_IO_WRITE:
     134           0 :                                 ftl_io_clear(io);
     135           0 :                                 TAILQ_INSERT_HEAD(&io->dev->wr_sq, io, queue_entry);
     136           0 :                                 break;
     137           0 :                         case FTL_IO_TRIM:
     138           0 :                                 ftl_io_clear(io);
     139           0 :                                 TAILQ_INSERT_HEAD(&io->dev->trim_sq, io, queue_entry);
     140           0 :                                 break;
     141           0 :                         default:
     142             :                                 /* Unknown IO type, complete to the user */
     143           0 :                                 assert(0);
     144             :                                 break;
     145             :                         }
     146             : 
     147             :                 }
     148             : 
     149           1 :                 if (!io->status) {
     150             :                         /* IO rescheduled, return from the function */
     151           0 :                         return;
     152             :                 }
     153             :         }
     154             : 
     155           3 :         if (io->map) {
     156           0 :                 ftl_mempool_put(ioch->map_pool, io->map);
     157             :         }
     158             : 
     159           3 :         result = spdk_ring_enqueue(ioch->cq, (void **)&io, 1, NULL);
     160           3 :         assert(result != 0);
     161             : }
     162             : 
     163             : int
     164           0 : ftl_io_init(struct spdk_io_channel *_ioch, struct ftl_io *io, uint64_t lba, size_t num_blocks,
     165             :             struct iovec *iov, size_t iov_cnt, spdk_ftl_fn cb_fn, void *cb_ctx, int type)
     166             : {
     167           0 :         struct ftl_io_channel *ioch = ftl_io_channel_get_ctx(_ioch);
     168           0 :         struct spdk_ftl_dev *dev = ioch->dev;
     169             : 
     170           0 :         memset(io, 0, sizeof(struct ftl_io));
     171           0 :         io->ioch = _ioch;
     172             : 
     173           0 :         io->flags |= FTL_IO_INITIALIZED;
     174           0 :         io->type = type;
     175           0 :         io->dev = dev;
     176           0 :         io->addr = FTL_ADDR_INVALID;
     177           0 :         io->cb_ctx = cb_ctx;
     178           0 :         io->lba = lba;
     179           0 :         io->user_fn = cb_fn;
     180           0 :         io->iov = iov;
     181           0 :         io->iov_cnt = iov_cnt;
     182           0 :         io->num_blocks = num_blocks;
     183           0 :         io->trace = ftl_trace_alloc_id(dev);
     184             : 
     185           0 :         ftl_trace_lba_io_init(io->dev, io);
     186           0 :         return 0;
     187             : }
     188             : 
     189             : static void
     190           0 : ftl_io_complete_verify(struct ftl_io *io)
     191             : {
     192           0 :         struct spdk_ftl_dev *dev = io->dev;
     193             :         uint64_t i;
     194           0 :         uint64_t lba = io->lba;
     195             : 
     196           0 :         assert(io->num_blocks <= dev->xfer_size);
     197             : 
     198           0 :         if (FTL_IO_WRITE == io->type) {
     199           0 :                 return;
     200             :         }
     201             : 
     202           0 :         if (spdk_unlikely(io->status)) {
     203           0 :                 return;
     204             :         }
     205             : 
     206           0 :         for (i = 0; i < io->num_blocks; i++, lba++) {
     207           0 :                 ftl_addr current_addr = ftl_l2p_get(dev, lba);
     208             : 
     209             :                 /* If user read request gets stuck for whatever reason, then it's possible the LBA
     210             :                  * has been relocated by GC or compaction and it may no longer be safe to return data
     211             :                  * from that address */
     212           0 :                 if (spdk_unlikely(current_addr != io->map[i])) {
     213           0 :                         io->status = -EAGAIN;
     214           0 :                         break;
     215             :                 }
     216             :         }
     217             : }
     218             : 
     219             : void
     220           3 : ftl_io_complete(struct ftl_io *io)
     221             : {
     222           3 :         io->flags &= ~FTL_IO_INITIALIZED;
     223           3 :         io->done = true;
     224             : 
     225           3 :         if (io->flags & FTL_IO_PINNED) {
     226           0 :                 ftl_io_complete_verify(io);
     227           0 :                 ftl_l2p_unpin(io->dev, io->lba, io->num_blocks);
     228             :         }
     229             : 
     230           3 :         ftl_io_cb(io, io->cb_ctx, io->status);
     231           3 : }
     232             : 
     233             : void
     234           0 : ftl_io_fail(struct ftl_io *io, int status)
     235             : {
     236           0 :         io->status = status;
     237           0 :         ftl_io_advance(io, io->num_blocks - io->pos);
     238           0 : }
     239             : 
     240             : void
     241           0 : ftl_io_clear(struct ftl_io *io)
     242             : {
     243           0 :         io->req_cnt = io->pos = io->iov_pos = io->iov_off = 0;
     244           0 :         io->done = false;
     245           0 :         io->status = 0;
     246           0 :         io->flags = 0;
     247           0 :         io->band = NULL;
     248           0 : }

Generated by: LCOV version 1.15