ceph/src/spdk/lib/ftl/ftl_addr.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_ADDR_H
  35 #define FTL_ADDR_H
  36
  37 #include "spdk/stdinc.h"
  38
  39 /* Marks address as invalid */
  40 #define FTL_ADDR_INVALID        (-1)
  41 /* Marks LBA as invalid */
  42 #define FTL_LBA_INVALID         ((uint64_t)-1)
  43 /* Smallest data unit size */
  44 #define FTL_BLOCK_SIZE          4096
  45
  46 /* This structure represents on-disk address. It can have one of the following */
  47 /* formats: */
  48 /*        - offset inside the disk */
  49 /*        - cache_offset inside the cache (indicated by the cached flag) */
  50 /*        - packed version of the two formats above (can be only used when the */
  51 /*          offset can be represented in less than 32 bits) */
  52 /* Packed format is used, when possible, to avoid wasting RAM on the L2P table. */
  53 struct ftl_addr {
  54         union {
  55                 struct {
  56                         uint64_t cache_offset : 63;
  57                         uint64_t cached       : 1;
  58                 };
  59
  60                 struct {
  61                         union {
  62                                 struct  {
  63                                         uint32_t cache_offset : 31;
  64                                         uint32_t cached       : 1;
  65                                 };
  66
  67                                 uint32_t offset;
  68                         };
  69                         uint32_t rsvd;
  70                 } pack;
  71
  72                 uint64_t offset;
  73         };
  74 };
  75
  76 #endif /* FTL_ADDR_H */