98d140d2af
Change-Id: I12e629d21f30372ae3c0d3939c036b0ae3562e6e Signed-off-by: Daniel Verkamp <daniel.verkamp@intel.com> Reviewed-on: https://review.gerrithub.io/412992 Tested-by: SPDK Automated Test System <sys_sgsw@intel.com> Reviewed-by: Jim Harris <james.r.harris@intel.com> Reviewed-by: Ben Walker <benjamin.walker@intel.com>
311 lines
10 KiB
C
311 lines
10 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 __NVMF_INTERNAL_H__
|
|
#define __NVMF_INTERNAL_H__
|
|
|
|
#include "spdk/stdinc.h"
|
|
|
|
#include "spdk/likely.h"
|
|
#include "spdk/nvmf.h"
|
|
#include "spdk/nvmf_spec.h"
|
|
#include "spdk/assert.h"
|
|
#include "spdk/queue.h"
|
|
#include "spdk/util.h"
|
|
|
|
enum spdk_nvmf_subsystem_state {
|
|
SPDK_NVMF_SUBSYSTEM_INACTIVE = 0,
|
|
SPDK_NVMF_SUBSYSTEM_ACTIVATING,
|
|
SPDK_NVMF_SUBSYSTEM_ACTIVE,
|
|
SPDK_NVMF_SUBSYSTEM_PAUSING,
|
|
SPDK_NVMF_SUBSYSTEM_PAUSED,
|
|
SPDK_NVMF_SUBSYSTEM_RESUMING,
|
|
SPDK_NVMF_SUBSYSTEM_DEACTIVATING,
|
|
};
|
|
|
|
enum spdk_nvmf_qpair_state {
|
|
SPDK_NVMF_QPAIR_INACTIVE = 0,
|
|
SPDK_NVMF_QPAIR_ACTIVATING,
|
|
SPDK_NVMF_QPAIR_ACTIVE,
|
|
SPDK_NVMF_QPAIR_DEACTIVATING,
|
|
};
|
|
|
|
struct spdk_nvmf_tgt {
|
|
struct spdk_nvmf_tgt_opts opts;
|
|
|
|
uint64_t discovery_genctr;
|
|
|
|
/* Array of subsystem pointers of size max_subsystems indexed by sid */
|
|
struct spdk_nvmf_subsystem **subsystems;
|
|
|
|
struct spdk_nvmf_discovery_log_page *discovery_log_page;
|
|
size_t discovery_log_page_size;
|
|
TAILQ_HEAD(, spdk_nvmf_transport) transports;
|
|
};
|
|
|
|
struct spdk_nvmf_host {
|
|
char *nqn;
|
|
TAILQ_ENTRY(spdk_nvmf_host) link;
|
|
};
|
|
|
|
struct spdk_nvmf_listener {
|
|
struct spdk_nvme_transport_id trid;
|
|
struct spdk_nvmf_transport *transport;
|
|
TAILQ_ENTRY(spdk_nvmf_listener) link;
|
|
};
|
|
|
|
struct spdk_nvmf_transport_poll_group {
|
|
struct spdk_nvmf_transport *transport;
|
|
TAILQ_ENTRY(spdk_nvmf_transport_poll_group) link;
|
|
};
|
|
|
|
struct spdk_nvmf_subsystem_poll_group {
|
|
/* Array of channels for each namespace indexed by nsid - 1 */
|
|
struct spdk_io_channel **channels;
|
|
uint32_t num_channels;
|
|
|
|
enum spdk_nvmf_subsystem_state state;
|
|
|
|
TAILQ_HEAD(, spdk_nvmf_request) queued;
|
|
};
|
|
|
|
struct spdk_nvmf_poll_group {
|
|
struct spdk_thread *thread;
|
|
struct spdk_poller *poller;
|
|
|
|
TAILQ_HEAD(, spdk_nvmf_transport_poll_group) tgroups;
|
|
|
|
/* Array of poll groups indexed by subsystem id (sid) */
|
|
struct spdk_nvmf_subsystem_poll_group *sgroups;
|
|
uint32_t num_sgroups;
|
|
};
|
|
|
|
typedef enum _spdk_nvmf_request_exec_status {
|
|
SPDK_NVMF_REQUEST_EXEC_STATUS_COMPLETE,
|
|
SPDK_NVMF_REQUEST_EXEC_STATUS_ASYNCHRONOUS,
|
|
} spdk_nvmf_request_exec_status;
|
|
|
|
union nvmf_h2c_msg {
|
|
struct spdk_nvmf_capsule_cmd nvmf_cmd;
|
|
struct spdk_nvme_cmd nvme_cmd;
|
|
struct spdk_nvmf_fabric_prop_set_cmd prop_set_cmd;
|
|
struct spdk_nvmf_fabric_prop_get_cmd prop_get_cmd;
|
|
struct spdk_nvmf_fabric_connect_cmd connect_cmd;
|
|
};
|
|
SPDK_STATIC_ASSERT(sizeof(union nvmf_h2c_msg) == 64, "Incorrect size");
|
|
|
|
union nvmf_c2h_msg {
|
|
struct spdk_nvme_cpl nvme_cpl;
|
|
struct spdk_nvmf_fabric_prop_get_rsp prop_get_rsp;
|
|
struct spdk_nvmf_fabric_connect_rsp connect_rsp;
|
|
};
|
|
SPDK_STATIC_ASSERT(sizeof(union nvmf_c2h_msg) == 16, "Incorrect size");
|
|
|
|
struct spdk_nvmf_request {
|
|
struct spdk_nvmf_qpair *qpair;
|
|
uint32_t length;
|
|
enum spdk_nvme_data_transfer xfer;
|
|
void *data;
|
|
union nvmf_h2c_msg *cmd;
|
|
union nvmf_c2h_msg *rsp;
|
|
|
|
TAILQ_ENTRY(spdk_nvmf_request) link;
|
|
};
|
|
|
|
struct spdk_nvmf_ns {
|
|
struct spdk_nvmf_subsystem *subsystem;
|
|
struct spdk_bdev *bdev;
|
|
struct spdk_bdev_desc *desc;
|
|
struct spdk_nvmf_ns_opts opts;
|
|
};
|
|
|
|
struct spdk_nvmf_qpair {
|
|
enum spdk_nvmf_qpair_state state;
|
|
|
|
struct spdk_nvmf_transport *transport;
|
|
struct spdk_nvmf_ctrlr *ctrlr;
|
|
struct spdk_nvmf_poll_group *group;
|
|
|
|
uint16_t qid;
|
|
uint16_t sq_head;
|
|
uint16_t sq_head_max;
|
|
|
|
TAILQ_HEAD(, spdk_nvmf_request) outstanding;
|
|
TAILQ_ENTRY(spdk_nvmf_qpair) link;
|
|
};
|
|
|
|
struct spdk_nvmf_ctrlr_feat {
|
|
union spdk_nvme_feat_arbitration arbitration;
|
|
union spdk_nvme_feat_power_management power_management;
|
|
union spdk_nvme_feat_error_recovery error_recovery;
|
|
union spdk_nvme_feat_volatile_write_cache volatile_write_cache;
|
|
union spdk_nvme_feat_number_of_queues number_of_queues;
|
|
union spdk_nvme_feat_write_atomicity write_atomicity;
|
|
union spdk_nvme_feat_async_event_configuration async_event_configuration;
|
|
union spdk_nvme_feat_keep_alive_timer keep_alive_timer;
|
|
};
|
|
|
|
/*
|
|
* This structure represents an NVMe-oF controller,
|
|
* which is like a "session" in networking terms.
|
|
*/
|
|
struct spdk_nvmf_ctrlr {
|
|
uint16_t cntlid;
|
|
struct spdk_nvmf_subsystem *subsys;
|
|
|
|
struct {
|
|
union spdk_nvme_cap_register cap;
|
|
union spdk_nvme_vs_register vs;
|
|
union spdk_nvme_cc_register cc;
|
|
union spdk_nvme_csts_register csts;
|
|
} vcprop; /* virtual controller properties */
|
|
|
|
struct spdk_nvmf_ctrlr_feat feat;
|
|
|
|
struct spdk_nvmf_qpair *admin_qpair;
|
|
TAILQ_HEAD(, spdk_nvmf_qpair) qpairs;
|
|
int num_qpairs;
|
|
int max_qpairs_allowed;
|
|
struct spdk_nvmf_request *aer_req;
|
|
union spdk_nvme_async_event_completion notice_event;
|
|
uint8_t hostid[16];
|
|
|
|
uint16_t changed_ns_list_count;
|
|
struct spdk_nvme_ns_list changed_ns_list;
|
|
|
|
TAILQ_ENTRY(spdk_nvmf_ctrlr) link;
|
|
};
|
|
|
|
struct spdk_nvmf_subsystem {
|
|
struct spdk_thread *thread;
|
|
uint32_t id;
|
|
enum spdk_nvmf_subsystem_state state;
|
|
|
|
char subnqn[SPDK_NVMF_NQN_MAX_LEN + 1];
|
|
enum spdk_nvmf_subtype subtype;
|
|
uint16_t next_cntlid;
|
|
bool allow_any_host;
|
|
|
|
struct spdk_nvmf_tgt *tgt;
|
|
|
|
char sn[SPDK_NVME_CTRLR_SN_LEN + 1];
|
|
|
|
/* Array of pointers to namespaces of size max_nsid indexed by nsid - 1 */
|
|
struct spdk_nvmf_ns **ns;
|
|
uint32_t max_nsid;
|
|
/* This is the maximum allowed nsid to a subsystem */
|
|
uint32_t max_allowed_nsid;
|
|
|
|
TAILQ_HEAD(, spdk_nvmf_ctrlr) ctrlrs;
|
|
|
|
TAILQ_HEAD(, spdk_nvmf_host) hosts;
|
|
|
|
TAILQ_HEAD(, spdk_nvmf_listener) listeners;
|
|
|
|
TAILQ_ENTRY(spdk_nvmf_subsystem) entries;
|
|
};
|
|
|
|
struct spdk_nvmf_transport *spdk_nvmf_tgt_get_transport(struct spdk_nvmf_tgt *tgt,
|
|
enum spdk_nvme_transport_type);
|
|
|
|
int spdk_nvmf_poll_group_add_transport(struct spdk_nvmf_poll_group *group,
|
|
struct spdk_nvmf_transport *transport);
|
|
int spdk_nvmf_poll_group_update_subsystem(struct spdk_nvmf_poll_group *group,
|
|
struct spdk_nvmf_subsystem *subsystem);
|
|
int spdk_nvmf_poll_group_add_subsystem(struct spdk_nvmf_poll_group *group,
|
|
struct spdk_nvmf_subsystem *subsystem);
|
|
int spdk_nvmf_poll_group_remove_subsystem(struct spdk_nvmf_poll_group *group,
|
|
struct spdk_nvmf_subsystem *subsystem);
|
|
int spdk_nvmf_poll_group_pause_subsystem(struct spdk_nvmf_poll_group *group,
|
|
struct spdk_nvmf_subsystem *subsystem);
|
|
int spdk_nvmf_poll_group_resume_subsystem(struct spdk_nvmf_poll_group *group,
|
|
struct spdk_nvmf_subsystem *subsystem);
|
|
void spdk_nvmf_request_exec(struct spdk_nvmf_request *req);
|
|
int spdk_nvmf_request_complete(struct spdk_nvmf_request *req);
|
|
int spdk_nvmf_request_abort(struct spdk_nvmf_request *req);
|
|
|
|
void spdk_nvmf_get_discovery_log_page(struct spdk_nvmf_tgt *tgt,
|
|
void *buffer, uint64_t offset,
|
|
uint32_t length);
|
|
|
|
struct spdk_nvmf_qpair *spdk_nvmf_ctrlr_get_qpair(struct spdk_nvmf_ctrlr *ctrlr, uint16_t qid);
|
|
void spdk_nvmf_ctrlr_destruct(struct spdk_nvmf_ctrlr *ctrlr);
|
|
int spdk_nvmf_ctrlr_process_fabrics_cmd(struct spdk_nvmf_request *req);
|
|
int spdk_nvmf_ctrlr_process_admin_cmd(struct spdk_nvmf_request *req);
|
|
int spdk_nvmf_ctrlr_process_io_cmd(struct spdk_nvmf_request *req);
|
|
bool spdk_nvmf_ctrlr_dsm_supported(struct spdk_nvmf_ctrlr *ctrlr);
|
|
bool spdk_nvmf_ctrlr_write_zeroes_supported(struct spdk_nvmf_ctrlr *ctrlr);
|
|
void spdk_nvmf_ctrlr_ns_changed(struct spdk_nvmf_ctrlr *ctrlr, uint32_t nsid);
|
|
|
|
int spdk_nvmf_bdev_ctrlr_identify_ns(struct spdk_nvmf_ns *ns, struct spdk_nvme_ns_data *nsdata);
|
|
|
|
int spdk_nvmf_subsystem_add_ctrlr(struct spdk_nvmf_subsystem *subsystem,
|
|
struct spdk_nvmf_ctrlr *ctrlr);
|
|
void spdk_nvmf_subsystem_remove_ctrlr(struct spdk_nvmf_subsystem *subsystem,
|
|
struct spdk_nvmf_ctrlr *ctrlr);
|
|
struct spdk_nvmf_ctrlr *spdk_nvmf_subsystem_get_ctrlr(struct spdk_nvmf_subsystem *subsystem,
|
|
uint16_t cntlid);
|
|
int spdk_nvmf_ctrlr_async_event_ns_notice(struct spdk_nvmf_ctrlr *ctrlr);
|
|
|
|
static inline struct spdk_nvmf_ns *
|
|
_spdk_nvmf_subsystem_get_ns(struct spdk_nvmf_subsystem *subsystem, uint32_t nsid)
|
|
{
|
|
/* NOTE: This implicitly also checks for 0, since 0 - 1 wraps around to UINT32_MAX. */
|
|
if (spdk_unlikely(nsid - 1 >= subsystem->max_nsid)) {
|
|
return NULL;
|
|
}
|
|
|
|
return subsystem->ns[nsid - 1];
|
|
}
|
|
|
|
static inline bool
|
|
spdk_nvmf_qpair_is_admin_queue(struct spdk_nvmf_qpair *qpair)
|
|
{
|
|
return qpair->qid == 0;
|
|
}
|
|
|
|
#define OBJECT_NVMF_IO 0x30
|
|
|
|
#define TRACE_GROUP_NVMF 0x3
|
|
#define TRACE_NVMF_IO_START SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x0)
|
|
#define TRACE_RDMA_READ_START SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x1)
|
|
#define TRACE_RDMA_WRITE_START SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x2)
|
|
#define TRACE_RDMA_READ_COMPLETE SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x3)
|
|
#define TRACE_RDMA_WRITE_COMPLETE SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x4)
|
|
#define TRACE_NVMF_LIB_READ_START SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x5)
|
|
#define TRACE_NVMF_LIB_WRITE_START SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x6)
|
|
#define TRACE_NVMF_LIB_COMPLETE SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x7)
|
|
#define TRACE_NVMF_IO_COMPLETE SPDK_TPOINT_ID(TRACE_GROUP_NVMF, 0x8)
|
|
|
|
#endif /* __NVMF_INTERNAL_H__ */
|