39b386a5c5
Change-Id: I094d5adb85af8279c9823528f40190fa28801b7b Signed-off-by: Cunyin Chang <cunyin.chang@intel.com>
133 lines
3.8 KiB
C
133 lines
3.8 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_NVMF_TRANSPORT_H
|
|
#define SPDK_NVMF_TRANSPORT_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "spdk/nvmf.h"
|
|
|
|
struct spdk_nvmf_listen_addr;
|
|
|
|
struct spdk_nvmf_transport {
|
|
/**
|
|
* Name of the transport.
|
|
*/
|
|
const char *name;
|
|
|
|
/**
|
|
* Initialize the transport.
|
|
*/
|
|
int (*transport_init)(uint16_t max_queue_depth, uint32_t max_io_size,
|
|
uint32_t in_capsule_data_size);
|
|
|
|
/**
|
|
* Shut down the transport.
|
|
*/
|
|
int (*transport_fini)(void);
|
|
|
|
/**
|
|
* Check for new connections on the transport.
|
|
*/
|
|
void (*acceptor_poll)(void);
|
|
|
|
/**
|
|
* Instruct the acceptor to listen on the address provided. This
|
|
* may be called multiple times.
|
|
*/
|
|
int (*listen_addr_add)(struct spdk_nvmf_listen_addr *listen_addr);
|
|
|
|
/**
|
|
* Instruct to remove listening on the address provided. This
|
|
* may be called multiple times.
|
|
*/
|
|
int (*listen_addr_remove)(struct spdk_nvmf_listen_addr *listen_addr);
|
|
|
|
/**
|
|
* Fill out a discovery log entry for a specific listen address.
|
|
*/
|
|
void (*listen_addr_discover)(struct spdk_nvmf_listen_addr *listen_addr,
|
|
struct spdk_nvmf_discovery_log_page_entry *entry);
|
|
|
|
/**
|
|
* Create a new session
|
|
*/
|
|
struct spdk_nvmf_session *(*session_init)(void);
|
|
|
|
/**
|
|
* Destroy a session
|
|
*/
|
|
void (*session_fini)(struct spdk_nvmf_session *session);
|
|
|
|
/**
|
|
* Add a connection to a session
|
|
*/
|
|
int (*session_add_conn)(struct spdk_nvmf_session *session, struct spdk_nvmf_conn *conn);
|
|
|
|
/**
|
|
* Remove a connection from a session
|
|
*/
|
|
int (*session_remove_conn)(struct spdk_nvmf_session *session, struct spdk_nvmf_conn *conn);
|
|
|
|
/*
|
|
* Signal request completion, which sends a response
|
|
* to the originator.
|
|
*/
|
|
int (*req_complete)(struct spdk_nvmf_request *req);
|
|
|
|
/*
|
|
* Deinitialize a connection.
|
|
*/
|
|
void (*conn_fini)(struct spdk_nvmf_conn *conn);
|
|
|
|
/*
|
|
* Poll a connection for events.
|
|
*/
|
|
int (*conn_poll)(struct spdk_nvmf_conn *conn);
|
|
|
|
/*
|
|
* True if the conn has no pending IO.
|
|
*/
|
|
bool (*conn_is_idle)(struct spdk_nvmf_conn *conn);
|
|
};
|
|
|
|
int spdk_nvmf_transport_init(void);
|
|
int spdk_nvmf_transport_fini(void);
|
|
|
|
const struct spdk_nvmf_transport *spdk_nvmf_transport_get(const char *name);
|
|
|
|
extern const struct spdk_nvmf_transport spdk_nvmf_transport_rdma;
|
|
|
|
#endif /* SPDK_NVMF_TRANSPORT_H */
|