ceph/src/spdk/lib/ftl/ftl_trace.h

   1 /*-
   2  *   BSD LICENSE
   3  *
   4  *   Copyright (c) Intel Corporation.
   5  *   All rights reserved.
   6  *
   7  *   Redistribution and use in source and binary forms, with or without
   8  *   modification, are permitted provided that the following conditions
   9  *   are met:
  10  *
  11  *     * Redistributions of source code must retain the above copyright
  12  *       notice, this list of conditions and the following disclaimer.
  13  *     * Redistributions in binary form must reproduce the above copyright
  14  *       notice, this list of conditions and the following disclaimer in
  15  *       the documentation and/or other materials provided with the
  16  *       distribution.
  17  *     * Neither the name of Intel Corporation nor the names of its
  18  *       contributors may be used to endorse or promote products derived
  19  *       from this software without specific prior written permission.
  20  *
  21  *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22  *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23  *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24  *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25  *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26  *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27  *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28  *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29  *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30  *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31  *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32  */
  33
  34 #ifndef FTL_TRACE_H
  35 #define FTL_TRACE_H
  36
  37 #include "ftl_ppa.h"
  38
  39 #define FTL_TRACE_INVALID_ID ((uint64_t) -1)
  40
  41 enum ftl_trace_completion {
  42         FTL_TRACE_COMPLETION_INVALID,
  43         FTL_TRACE_COMPLETION_CACHE,
  44         FTL_TRACE_COMPLETION_DISK,
  45 };
  46
  47 struct ftl_trace {
  48         /* Monotonically incrementing event id */
  49         uint64_t                id;
  50 };
  51
  52 struct spdk_ftl_dev;
  53 struct ftl_trace;
  54 struct ftl_io;
  55 struct ftl_rwb_entry;
  56 struct ftl_band;
  57
  58 uint64_t ftl_trace_alloc_id(struct spdk_ftl_dev *dev);
  59 void ftl_trace_defrag_band(struct spdk_ftl_dev *dev, const struct ftl_band *band);
  60 void ftl_trace_write_band(struct spdk_ftl_dev *dev, const struct ftl_band *band);
  61 void ftl_trace_lba_io_init(struct spdk_ftl_dev *dev, const struct ftl_io *io);
  62 void ftl_trace_rwb_fill(struct spdk_ftl_dev *dev, const struct ftl_io *io);
  63 void ftl_trace_rwb_pop(struct spdk_ftl_dev *dev, const struct ftl_rwb_entry *entry);
  64 void ftl_trace_submission(struct spdk_ftl_dev *dev,
  65                           const struct ftl_io *io,
  66                           struct ftl_ppa ppa, size_t ppa_cnt);
  67 void ftl_trace_completion(struct spdk_ftl_dev *dev,
  68                           const struct ftl_io *io,
  69                           enum ftl_trace_completion type);
  70 void ftl_trace_limits(struct spdk_ftl_dev *dev, const size_t *limits, size_t num_free);
  71
  72 #endif /* FTL_TRACE_H */