ceph/src/spdk/lib/bdev/nvme/bdev_nvme.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_NVME_H
  35 #define SPDK_BDEV_NVME_H
  36
  37 #include "spdk/stdinc.h"
  38
  39 #include "spdk/queue.h"
  40 #include "spdk/nvme.h"
  41 #include "spdk/bdev_module.h"
  42
  43 #define NVME_MAX_CONTROLLERS 1024
  44
  45 enum spdk_bdev_timeout_action {
  46         SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE = 0,
  47         SPDK_BDEV_NVME_TIMEOUT_ACTION_RESET,
  48         SPDK_BDEV_NVME_TIMEOUT_ACTION_ABORT,
  49 };
  50
  51 struct spdk_bdev_nvme_opts {
  52         enum spdk_bdev_timeout_action action_on_timeout;
  53         uint64_t timeout_us;
  54         uint32_t retry_count;
  55         uint64_t nvme_adminq_poll_period_us;
  56 };
  57
  58 struct nvme_ctrlr {
  59         /**
  60          * points to pinned, physically contiguous memory region;
  61          * contains 4KB IDENTIFY structure for controller which is
  62          *  target for CONTROLLER IDENTIFY command during initialization
  63          */
  64         struct spdk_nvme_ctrlr          *ctrlr;
  65         struct spdk_nvme_transport_id   trid;
  66         char                            *name;
  67         int                             ref;
  68         uint32_t                        num_ns;
  69         /** Array of bdevs indexed by nsid - 1 */
  70         struct nvme_bdev                *bdevs;
  71
  72         struct spdk_poller              *adminq_timer_poller;
  73
  74         /** linked list pointer for device list */
  75         TAILQ_ENTRY(nvme_ctrlr) tailq;
  76 };
  77
  78 struct nvme_bdev {
  79         struct spdk_bdev        disk;
  80         struct nvme_ctrlr       *nvme_ctrlr;
  81         uint32_t                id;
  82         bool                    active;
  83         struct spdk_nvme_ns     *ns;
  84 };
  85
  86 void spdk_bdev_nvme_dump_trid_json(struct spdk_nvme_transport_id *trid,
  87                                    struct spdk_json_write_ctx *w);
  88
  89 struct spdk_nvme_qpair *spdk_bdev_nvme_get_io_qpair(struct spdk_io_channel *ctrlr_io_ch);
  90 struct nvme_ctrlr *spdk_bdev_nvme_lookup_ctrlr(const char *ctrlr_name);
  91 struct nvme_ctrlr *spdk_bdev_nvme_first_ctrlr(void);
  92 struct nvme_ctrlr *spdk_bdev_nvme_next_ctrlr(struct nvme_ctrlr *prev);
  93 void spdk_bdev_nvme_get_opts(struct spdk_bdev_nvme_opts *opts);
  94 int spdk_bdev_nvme_set_opts(const struct spdk_bdev_nvme_opts *opts);
  95 int spdk_bdev_nvme_set_hotplug(bool enabled, uint64_t period_us, spdk_thread_fn cb, void *cb_ctx);
  96
  97 int spdk_bdev_nvme_create(struct spdk_nvme_transport_id *trid,
  98                           const char *base_name,
  99                           const char **names, size_t *count,
 100                           const char *hostnqn);
 101 struct spdk_nvme_ctrlr *spdk_bdev_nvme_get_ctrlr(struct spdk_bdev *bdev);
 102
 103 /**
 104  * Delete NVMe controller with all bdevs on top of it.
 105  * Requires to pass name of NVMe controller.
 106  *
 107  * \param name NVMe controller name
 108  * \return zero on success, -EINVAL on wrong parameters or -ENODEV if controller is not found
 109  */
 110 int spdk_bdev_nvme_delete(const char *name);
 111
 112 #endif // SPDK_BDEV_NVME_H