50d7ad0676
PI check flags is not set to NVMe controllers created by hot plug handler automatically. Document this behavior for clarification. Change-Id: I9590d0cb7f53a24c33afd706e222065893d23cb4 Signed-off-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com> Reviewed-on: https://review.gerrithub.io/c/444012 Tested-by: SPDK CI Jenkins <sys_sgci@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Changpeng Liu <changpeng.liu@intel.com> Reviewed-by: Darek Stojaczyk <dariusz.stojaczyk@intel.com>
122 lines
4.2 KiB
C
122 lines
4.2 KiB
C
/*-
|
|
* BSD LICENSE
|
|
*
|
|
* Copyright (c) Intel Corporation.
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* * Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* * Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in
|
|
* the documentation and/or other materials provided with the
|
|
* distribution.
|
|
* * Neither the name of Intel Corporation nor the names of its
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#ifndef SPDK_BDEV_NVME_H
|
|
#define SPDK_BDEV_NVME_H
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#include "spdk/queue.h"
|
|
#include "spdk/nvme.h"
|
|
#include "spdk/bdev_module.h"
|
|
|
|
#define NVME_MAX_CONTROLLERS 1024
|
|
|
|
enum spdk_bdev_timeout_action {
|
|
SPDK_BDEV_NVME_TIMEOUT_ACTION_NONE = 0,
|
|
SPDK_BDEV_NVME_TIMEOUT_ACTION_RESET,
|
|
SPDK_BDEV_NVME_TIMEOUT_ACTION_ABORT,
|
|
};
|
|
|
|
struct spdk_bdev_nvme_opts {
|
|
enum spdk_bdev_timeout_action action_on_timeout;
|
|
uint64_t timeout_us;
|
|
uint32_t retry_count;
|
|
uint64_t nvme_adminq_poll_period_us;
|
|
};
|
|
|
|
struct nvme_ctrlr {
|
|
/**
|
|
* points to pinned, physically contiguous memory region;
|
|
* contains 4KB IDENTIFY structure for controller which is
|
|
* target for CONTROLLER IDENTIFY command during initialization
|
|
*/
|
|
struct spdk_nvme_ctrlr *ctrlr;
|
|
struct spdk_nvme_transport_id trid;
|
|
char *name;
|
|
int ref;
|
|
bool destruct;
|
|
/**
|
|
* PI check flags. This flags is set to NVMe controllers created only
|
|
* through construct_nvme_bdev RPC or .INI config file. Hot added
|
|
* NVMe controllers are not included.
|
|
*/
|
|
uint32_t prchk_flags;
|
|
uint32_t num_ns;
|
|
/** Array of bdevs indexed by nsid - 1 */
|
|
struct nvme_bdev *bdevs;
|
|
|
|
struct spdk_poller *adminq_timer_poller;
|
|
|
|
/** linked list pointer for device list */
|
|
TAILQ_ENTRY(nvme_ctrlr) tailq;
|
|
};
|
|
|
|
struct nvme_bdev {
|
|
struct spdk_bdev disk;
|
|
struct nvme_ctrlr *nvme_ctrlr;
|
|
uint32_t id;
|
|
bool active;
|
|
struct spdk_nvme_ns *ns;
|
|
};
|
|
|
|
void spdk_bdev_nvme_dump_trid_json(struct spdk_nvme_transport_id *trid,
|
|
struct spdk_json_write_ctx *w);
|
|
|
|
struct spdk_nvme_qpair *spdk_bdev_nvme_get_io_qpair(struct spdk_io_channel *ctrlr_io_ch);
|
|
struct nvme_ctrlr *spdk_bdev_nvme_lookup_ctrlr(const char *ctrlr_name);
|
|
struct nvme_ctrlr *spdk_bdev_nvme_first_ctrlr(void);
|
|
struct nvme_ctrlr *spdk_bdev_nvme_next_ctrlr(struct nvme_ctrlr *prev);
|
|
void spdk_bdev_nvme_get_opts(struct spdk_bdev_nvme_opts *opts);
|
|
int spdk_bdev_nvme_set_opts(const struct spdk_bdev_nvme_opts *opts);
|
|
int spdk_bdev_nvme_set_hotplug(bool enabled, uint64_t period_us, spdk_msg_fn cb, void *cb_ctx);
|
|
|
|
int spdk_bdev_nvme_create(struct spdk_nvme_transport_id *trid,
|
|
struct spdk_nvme_host_id *hostid,
|
|
const char *base_name,
|
|
const char **names, size_t *count,
|
|
const char *hostnqn,
|
|
uint32_t prchk_flags);
|
|
struct spdk_nvme_ctrlr *spdk_bdev_nvme_get_ctrlr(struct spdk_bdev *bdev);
|
|
|
|
/**
|
|
* Delete NVMe controller with all bdevs on top of it.
|
|
* Requires to pass name of NVMe controller.
|
|
*
|
|
* \param name NVMe controller name
|
|
* \return zero on success, -EINVAL on wrong parameters or -ENODEV if controller is not found
|
|
*/
|
|
int spdk_bdev_nvme_delete(const char *name);
|
|
|
|
#endif /* SPDK_BDEV_NVME_H */
|