ceph/src/spdk/lib/bdev/nvme/bdev_ftl.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 SPDK_BDEV_FTL_H
  35 #define SPDK_BDEV_FTL_H
  36
  37 #include "spdk/stdinc.h"
  38 #include "spdk/nvme.h"
  39 #include "spdk/bdev_module.h"
  40 #include "spdk/ftl.h"
  41
  42 #define FTL_MAX_CONTROLLERS     64
  43 #define FTL_MAX_BDEVS           (FTL_MAX_CONTROLLERS * 128)
  44 #define FTL_RANGE_MAX_LENGTH    32
  45
  46 struct spdk_bdev;
  47 struct spdk_uuid;
  48
  49 struct ftl_bdev_info {
  50         const char              *name;
  51         struct spdk_uuid        uuid;
  52 };
  53
  54 struct ftl_bdev_init_opts {
  55         /* NVMe controller's transport ID */
  56         struct spdk_nvme_transport_id           trid;
  57         /* Parallel unit range */
  58         struct spdk_ftl_punit_range             range;
  59         /* Bdev's name */
  60         const char                              *name;
  61         /* Write buffer bdev's name */
  62         const char                              *cache_bdev;
  63         /* Bdev's mode */
  64         uint32_t                                mode;
  65         /* UUID if device is restored from SSD */
  66         struct spdk_uuid                        uuid;
  67         /* Allow for partial restore after dirty shutdown */
  68         bool                                    allow_open_bands;
  69 };
  70
  71 typedef void (*ftl_bdev_init_fn)(const struct ftl_bdev_info *, void *, int);
  72
  73 int     bdev_ftl_parse_punits(struct spdk_ftl_punit_range *range, const char *range_string);
  74 int     bdev_ftl_init_bdev(struct ftl_bdev_init_opts *opts, ftl_bdev_init_fn cb,
  75                            void *cb_arg);
  76 void    bdev_ftl_delete_bdev(const char *name, spdk_bdev_unregister_cb cb_fn, void *cb_arg);
  77
  78 #endif /* SPDK_BDEV_FTL_H */