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_addr.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_wbuf_entry; 56 struct ftl_band; 57 58 #if defined(DEBUG) 59 uint64_t ftl_trace_alloc_id(struct spdk_ftl_dev *dev); 60 void ftl_trace_defrag_band(struct spdk_ftl_dev *dev, const struct ftl_band *band); 61 void ftl_trace_write_band(struct spdk_ftl_dev *dev, const struct ftl_band *band); 62 void ftl_trace_lba_io_init(struct spdk_ftl_dev *dev, const struct ftl_io *io); 63 void ftl_trace_wbuf_fill(struct spdk_ftl_dev *dev, const struct ftl_io *io); 64 void ftl_trace_wbuf_pop(struct spdk_ftl_dev *dev, const struct ftl_wbuf_entry *entry); 65 void ftl_trace_submission(struct spdk_ftl_dev *dev, 66 const struct ftl_io *io, 67 struct ftl_addr addr, size_t addr_cnt); 68 void ftl_trace_completion(struct spdk_ftl_dev *dev, 69 const struct ftl_io *io, 70 enum ftl_trace_completion type); 71 void ftl_trace_limits(struct spdk_ftl_dev *dev, int limit, size_t num_free); 72 #else /* defined(DEBUG) */ 73 #define ftl_trace_alloc_id(dev) FTL_TRACE_INVALID_ID 74 #define ftl_trace_defrag_band(dev, band) 75 #define ftl_trace_write_band(dev, band) 76 #define ftl_trace_lba_io_init(dev, io) 77 #define ftl_trace_wbuf_fill(dev, io) 78 #define ftl_trace_wbuf_pop(dev, entry) 79 #define ftl_trace_submission(dev, io, addr, addr_cnt) 80 #define ftl_trace_completion(dev, io, type) 81 #define ftl_trace_limits(dev, limits, num_free) 82 #endif 83 84 #endif /* FTL_TRACE_H */ 85