SCSI to bdev translation layer. More...

Data Structures
struct	spdk_scsi_task

Macros
#define	SPDK_SCSI_MAX_DEVS 1024

#define	SPDK_SCSI_DEV_MAX_PORTS 4

#define	SPDK_SCSI_DEV_MAX_NAME 255

#define	SPDK_SCSI_PORT_MAX_NAME_LENGTH 255

#define	SPDK_SCSI_MAX_TRANSPORT_ID_LENGTH 255

Typedefs
typedef void(*	spdk_scsi_task_cpl) (struct spdk_scsi_task *task)

typedef void(*	spdk_scsi_task_free) (struct spdk_scsi_task *task)

typedef void(*	spdk_scsi_lun_remove_cb_t) (struct spdk_scsi_lun , void )

typedef void(*	spdk_scsi_dev_destruct_cb_t) (void *cb_arg, int rc)

Enumerations
enum	spdk_scsi_data_dir { SPDK_SCSI_DIR_NONE = 0 , SPDK_SCSI_DIR_TO_DEV = 1 , SPDK_SCSI_DIR_FROM_DEV = 2 }

enum	spdk_scsi_task_func { SPDK_SCSI_TASK_FUNC_ABORT_TASK = 0 , SPDK_SCSI_TASK_FUNC_ABORT_TASK_SET , SPDK_SCSI_TASK_FUNC_CLEAR_TASK_SET , SPDK_SCSI_TASK_FUNC_LUN_RESET , SPDK_SCSI_TASK_FUNC_TARGET_RESET }

enum	spdk_scsi_task_mgmt_resp { SPDK_SCSI_TASK_MGMT_RESP_COMPLETE , SPDK_SCSI_TASK_MGMT_RESP_SUCCESS , SPDK_SCSI_TASK_MGMT_RESP_REJECT , SPDK_SCSI_TASK_MGMT_RESP_INVALID_LUN , SPDK_SCSI_TASK_MGMT_RESP_TARGET_FAILURE , SPDK_SCSI_TASK_MGMT_RESP_REJECT_FUNC_NOT_SUPPORTED }

Functions
int	spdk_scsi_init (void)
	Initialize SCSI layer.

void	spdk_scsi_fini (void)
	Stop and clean the SCSI layer.

int	spdk_scsi_lun_get_id (const struct spdk_scsi_lun *lun)
	Get the LUN id of the given logical unit.

const char *	spdk_scsi_lun_get_bdev_name (const struct spdk_scsi_lun *lun)
	Get the name of the bdev associated with the given logical unit.

const struct spdk_scsi_dev *	spdk_scsi_lun_get_dev (const struct spdk_scsi_lun *lun)
	Get the SCSI device associated with the given logical unit.

bool	spdk_scsi_lun_is_removing (const struct spdk_scsi_lun *lun)
	Check if the logical unit is hot removing.

const char *	spdk_scsi_dev_get_name (const struct spdk_scsi_dev *dev)
	Get the name of the given SCSI device.

int	spdk_scsi_dev_get_id (const struct spdk_scsi_dev *dev)
	Get the id of the given SCSI device.

struct spdk_scsi_lun *	spdk_scsi_dev_get_lun (struct spdk_scsi_dev *dev, int lun_id)
	Get the logical unit of the given SCSI device whose id is lun_id.

struct spdk_scsi_lun *	spdk_scsi_dev_get_first_lun (struct spdk_scsi_dev *dev)
	Get the first logical unit of the given SCSI device.

struct spdk_scsi_lun *	spdk_scsi_dev_get_next_lun (struct spdk_scsi_lun *prev_lun)
	Get the next logical unit of a SCSI device.

bool	spdk_scsi_dev_has_pending_tasks (const struct spdk_scsi_dev dev, const struct spdk_scsi_port initiator_port)
	Check whether the SCSI device has any pending task.

void	spdk_scsi_dev_destruct (struct spdk_scsi_dev dev, spdk_scsi_dev_destruct_cb_t cb_fn, void cb_arg)
	Destruct the SCSI device.

void	spdk_scsi_dev_queue_mgmt_task (struct spdk_scsi_dev dev, struct spdk_scsi_task task)
	Execute the SCSI management task.

void	spdk_scsi_dev_queue_task (struct spdk_scsi_dev dev, struct spdk_scsi_task task)
	Execute the SCSI task.

int	spdk_scsi_dev_add_port (struct spdk_scsi_dev dev, uint64_t id, const char name)
	Add a new port to the given SCSI device.

int	spdk_scsi_dev_delete_port (struct spdk_scsi_dev *dev, uint64_t id)
	Delete a specified port of the given SCSI device.

struct spdk_scsi_port *	spdk_scsi_dev_find_port_by_id (struct spdk_scsi_dev *dev, uint64_t id)
	Get the port of the given SCSI device whose port ID is id.

int	spdk_scsi_dev_allocate_io_channels (struct spdk_scsi_dev *dev)
	Allocate I/O channels for all LUNs of the given SCSI device.

void	spdk_scsi_dev_free_io_channels (struct spdk_scsi_dev *dev)
	Free I/O channels from all LUNs of the given SCSI device.

struct spdk_scsi_dev *	spdk_scsi_dev_construct (const char name, const char bdev_name_list[], int lun_id_list, int num_luns, uint8_t protocol_id, void(hotremove_cb)(const struct spdk_scsi_lun , void ), void *hotremove_ctx)
	Construct a SCSI device object using the given parameters.

struct spdk_scsi_dev *	spdk_scsi_dev_construct_ext (const char name, const char bdev_name_list[], int lun_id_list, int num_luns, uint8_t protocol_id, void(resize_cb)(const struct spdk_scsi_lun , void ), void resize_ctx, void(hotremove_cb)(const struct spdk_scsi_lun , void ), void *hotremove_ctx)
	Construct a SCSI device object using the more given parameters.

void	spdk_scsi_dev_delete_lun (struct spdk_scsi_dev dev, struct spdk_scsi_lun lun)
	Delete a logical unit of the given SCSI device.

int	spdk_scsi_dev_add_lun (struct spdk_scsi_dev dev, const char bdev_name, int lun_id, void(hotremove_cb)(const struct spdk_scsi_lun , void ), void hotremove_ctx)
	Add a new logical unit to the given SCSI device.

int	spdk_scsi_dev_add_lun_ext (struct spdk_scsi_dev dev, const char bdev_name, int lun_id, void(resize_cb)(const struct spdk_scsi_lun , void ), void resize_ctx, void(hotremove_cb)(const struct spdk_scsi_lun , void ), void hotremove_ctx)
	Add a new logical unit to the given SCSI device with more callbacks.

struct spdk_scsi_port *	spdk_scsi_port_create (uint64_t id, uint16_t index, const char *name)
	Create a new SCSI port.

void	spdk_scsi_port_free (struct spdk_scsi_port **pport)
	Free the SCSI port.

const char *	spdk_scsi_port_get_name (const struct spdk_scsi_port *port)
	Get the name of the SCSI port.

void	spdk_scsi_task_construct (struct spdk_scsi_task *task, spdk_scsi_task_cpl cpl_fn, spdk_scsi_task_free free_fn)
	Construct a new SCSI task.

void	spdk_scsi_task_put (struct spdk_scsi_task *task)
	Put the SCSI task.

void	spdk_scsi_task_set_data (struct spdk_scsi_task task, void data, uint32_t len)
	Set internal buffer to given one.

int	spdk_scsi_task_scatter_data (struct spdk_scsi_task task, const void src, size_t len)
	Single buffer -> vector of buffers.

void *	spdk_scsi_task_gather_data (struct spdk_scsi_task task, int len)
	Vector of buffers -> single buffer.

void	spdk_scsi_task_build_sense_data (struct spdk_scsi_task *task, int sk, int asc, int ascq)
	Build sense data for the SCSI task.

void	spdk_scsi_task_set_status (struct spdk_scsi_task *task, int sc, int sk, int asc, int ascq)
	Set SCSI status code to the SCSI task.

void	spdk_scsi_task_copy_status (struct spdk_scsi_task dst, struct spdk_scsi_task src)
	Copy SCSI status.

void	spdk_scsi_task_process_null_lun (struct spdk_scsi_task *task)
	Process the SCSI task when no LUN is attached.

void	spdk_scsi_task_process_abort (struct spdk_scsi_task *task)
	Process the aborted SCSI task.

int	spdk_scsi_lun_open (struct spdk_scsi_lun lun, spdk_scsi_lun_remove_cb_t hotremove_cb, void hotremove_ctx, struct spdk_scsi_lun_desc **desc)
	Open a logical unit for I/O operations.

void	spdk_scsi_lun_close (struct spdk_scsi_lun_desc *desc)
	Close an opened logical unit.

int	spdk_scsi_lun_allocate_io_channel (struct spdk_scsi_lun_desc *desc)
	Allocate I/O channel for the LUN.

void	spdk_scsi_lun_free_io_channel (struct spdk_scsi_lun_desc *desc)
	Free I/O channel from the logical unit.

bool	spdk_scsi_lun_get_dif_ctx (struct spdk_scsi_lun lun, struct spdk_scsi_task task, struct spdk_dif_ctx *dif_ctx)
	Get DIF context for SCSI LUN and SCSI command.

void	spdk_scsi_port_set_iscsi_transport_id (struct spdk_scsi_port port, char iscsi_name, uint64_t isid)
	Set iSCSI Initiator port TransportID.

uint64_t	spdk_scsi_lun_id_int_to_fmt (int lun_id)
	Convert LUN ID from integer to LUN format.

int	spdk_scsi_lun_id_fmt_to_int (uint64_t fmt_lun)
	Convert LUN ID from LUN format to integer.

const char *	spdk_scsi_sbc_opcode_string (uint8_t opcode, uint16_t sa)
	Translate SCSI operation code and service action into string.

Detailed Description

SCSI to bdev translation layer.

Function Documentation

◆ spdk_scsi_dev_add_lun()

int spdk_scsi_dev_add_lun	(	struct spdk_scsi_dev *	dev,
		const char *	bdev_name,
		int	lun_id,
		void()(const struct spdk_scsi_lun , void *)	hotremove_cb,
		void *	hotremove_ctx )

Add a new logical unit to the given SCSI device.

Parameters

dev	SCSI device.
bdev_name	Name of the bdev attached to the logical unit.
lun_id	LUN id for the new logical unit.
hotremove_cb	Callback to lun hotremoval. Will be called once hotremove is first triggered.
hotremove_ctx	Additional argument to hotremove_cb.

◆ spdk_scsi_dev_add_lun_ext()

int spdk_scsi_dev_add_lun_ext	(	struct spdk_scsi_dev *	dev,
		const char *	bdev_name,
		int	lun_id,
		void()(const struct spdk_scsi_lun , void *)	resize_cb,
		void *	resize_ctx,
		void()(const struct spdk_scsi_lun , void *)	hotremove_cb,
		void *	hotremove_ctx )

Add a new logical unit to the given SCSI device with more callbacks.

Parameters

dev	SCSI device.
bdev_name	Name of the bdev attached to the logical unit.
lun_id	LUN id for the new logical unit.
resize_cb	Callback of lun resize.
resize_ctx	Additional argument to resize_cb.
hotremove_cb	Callback to lun hotremoval. Will be called once hotremove is first triggered.
hotremove_ctx	Additional argument to hotremove_cb.

◆ spdk_scsi_dev_add_port()

int spdk_scsi_dev_add_port	(	struct spdk_scsi_dev *	dev,
		uint64_t	id,
		const char *	name )

Add a new port to the given SCSI device.

Parameters

dev	SCSI device.
id	Port id.
name	Port name.

Returns: 0 on success, -1 on failure.

◆ spdk_scsi_dev_allocate_io_channels()

int spdk_scsi_dev_allocate_io_channels ( struct spdk_scsi_dev * dev )

Allocate I/O channels for all LUNs of the given SCSI device.

Parameters

dev	SCSI device.

Returns: 0 on success, -1 on failure.

◆ spdk_scsi_dev_construct()

struct spdk_scsi_dev * spdk_scsi_dev_construct	(	const char *	name,
		const char *	bdev_name_list[],
		int *	lun_id_list,
		int	num_luns,
		uint8_t	protocol_id,
		void()(const struct spdk_scsi_lun , void *)	hotremove_cb,
		void *	hotremove_ctx )

Construct a SCSI device object using the given parameters.

Parameters

name	Name for the SCSI device.
bdev_name_list	List of bdev names to attach to the LUNs for this SCSI device.
lun_id_list	List of LUN IDs for the LUN in this SCSI device. Caller is responsible for managing the memory containing this list. lun_id_list[x] is the LUN ID for lun_list[x].
num_luns	Number of entries in lun_list and lun_id_list.
protocol_id	SCSI SPC protocol identifier to report in INQUIRY data
hotremove_cb	Callback to lun hotremoval. Will be called once hotremove is first triggered.
hotremove_ctx	Additional argument to hotremove_cb.

Returns: the constructed spdk_scsi_dev object.

◆ spdk_scsi_dev_construct_ext()

struct spdk_scsi_dev * spdk_scsi_dev_construct_ext	(	const char *	name,
		const char *	bdev_name_list[],
		int *	lun_id_list,
		int	num_luns,
		uint8_t	protocol_id,
		void()(const struct spdk_scsi_lun , void *)	resize_cb,
		void *	resize_ctx,
		void()(const struct spdk_scsi_lun , void *)	hotremove_cb,
		void *	hotremove_ctx )

Construct a SCSI device object using the more given parameters.

Parameters

name	Name for the SCSI device.
bdev_name_list	List of bdev names to attach to the LUNs for this SCSI device.
lun_id_list	List of LUN IDs for the LUN in this SCSI device. Caller is responsible for managing the memory containing this list. lun_id_list[x] is the LUN ID for lun_list[x].
num_luns	Number of entries in lun_list and lun_id_list.
protocol_id	SCSI SPC protocol identifier to report in INQUIRY data
resize_cb	Callback of lun resize.
resize_ctx	Additional argument to resize_cb.
hotremove_cb	Callback to lun hotremoval. Will be called once hotremove is first triggered.
hotremove_ctx	Additional argument to hotremove_cb.

Returns: the constructed spdk_scsi_dev object.

◆ spdk_scsi_dev_delete_lun()

void spdk_scsi_dev_delete_lun	(	struct spdk_scsi_dev *	dev,
		struct spdk_scsi_lun *	lun )

Delete a logical unit of the given SCSI device.

Parameters

dev	SCSI device.
lun	Logical unit to delete.

◆ spdk_scsi_dev_delete_port()

int spdk_scsi_dev_delete_port	(	struct spdk_scsi_dev *	dev,
		uint64_t	id )

Delete a specified port of the given SCSI device.

Parameters

dev	SCSI device.
id	Port id.

Returns: 0 on success, -1 on failure.

◆ spdk_scsi_dev_destruct()

void spdk_scsi_dev_destruct	(	struct spdk_scsi_dev *	dev,
		spdk_scsi_dev_destruct_cb_t	cb_fn,
		void *	cb_arg )

Destruct the SCSI device.

Parameters

dev	SCSI device.
cb_fn	Callback function.
cb_arg	Argument to callback function.

◆ spdk_scsi_dev_find_port_by_id()

struct spdk_scsi_port * spdk_scsi_dev_find_port_by_id	(	struct spdk_scsi_dev *	dev,
		uint64_t	id )

Get the port of the given SCSI device whose port ID is id.

Parameters

dev	SCSI device.
id	Port id.

Returns: the port of the SCSI device on success, or NULL on failure.

◆ spdk_scsi_dev_get_first_lun()

struct spdk_scsi_lun * spdk_scsi_dev_get_first_lun ( struct spdk_scsi_dev * dev )

Get the first logical unit of the given SCSI device.

Parameters

dev	SCSI device.

Returns: the first logical unit on success, or NULL if there is no logical unit.

◆ spdk_scsi_dev_get_id()

int spdk_scsi_dev_get_id ( const struct spdk_scsi_dev * dev )

Get the id of the given SCSI device.

Parameters

dev	SCSI device.

Returns: the id of the SCSI device.

◆ spdk_scsi_dev_get_lun()

struct spdk_scsi_lun * spdk_scsi_dev_get_lun	(	struct spdk_scsi_dev *	dev,
		int	lun_id )

Get the logical unit of the given SCSI device whose id is lun_id.

Parameters

dev	SCSI device.
lun_id	Id of the logical unit.

Returns: the logical unit on success, or NULL on failure.

◆ spdk_scsi_dev_get_name()

const char * spdk_scsi_dev_get_name ( const struct spdk_scsi_dev * dev )

Get the name of the given SCSI device.

Parameters

dev	SCSI device.

Returns: the name of the SCSI device on success, or NULL on failure.

◆ spdk_scsi_dev_get_next_lun()

struct spdk_scsi_lun * spdk_scsi_dev_get_next_lun ( struct spdk_scsi_lun * prev_lun )

Get the next logical unit of a SCSI device.

Parameters

prev_lun Previous logical unit.

Returns: the next logical unit of a SCSI device, or NULL if the prev_lun was the last.

◆ spdk_scsi_dev_has_pending_tasks()

bool spdk_scsi_dev_has_pending_tasks	(	const struct spdk_scsi_dev *	dev,
		const struct spdk_scsi_port *	initiator_port )

Check whether the SCSI device has any pending task.

Parameters

dev	SCSI device.
initiator_port	Check tasks only from the initiator if specified, or all all tasks otherwise.

Returns: true if the SCSI device has any pending task, or false otherwise.

◆ spdk_scsi_dev_queue_mgmt_task()

void spdk_scsi_dev_queue_mgmt_task	(	struct spdk_scsi_dev *	dev,
		struct spdk_scsi_task *	task )

Execute the SCSI management task.

The task can be constructed by the function spdk_scsi_task_construct(). Code of task management function to be executed is set before calling this API.

Parameters

dev	SCSI device.
task	SCSI task to be executed.

◆ spdk_scsi_dev_queue_task()

void spdk_scsi_dev_queue_task	(	struct spdk_scsi_dev *	dev,
		struct spdk_scsi_task *	task )

Execute the SCSI task.

The task can be constructed by the function spdk_scsi_task_construct().

Parameters

dev	SCSI device.
task	Task to be executed.

◆ spdk_scsi_init()

int spdk_scsi_init ( void )

Initialize SCSI layer.

Returns: 0 on success, -1 on failure.

◆ spdk_scsi_lun_allocate_io_channel()

int spdk_scsi_lun_allocate_io_channel ( struct spdk_scsi_lun_desc * desc )

Allocate I/O channel for the LUN.

Parameters

desc	Descriptor of the logical unit.

Returns: 0 on success, -1 on failure.

◆ spdk_scsi_lun_close()

void spdk_scsi_lun_close ( struct spdk_scsi_lun_desc * desc )

Close an opened logical unit.

Parameters

desc	Descriptor of the logical unit.

◆ spdk_scsi_lun_free_io_channel()

void spdk_scsi_lun_free_io_channel ( struct spdk_scsi_lun_desc * desc )

Free I/O channel from the logical unit.

Parameters

desc	Descriptor of the logical unit.

◆ spdk_scsi_lun_get_bdev_name()

const char * spdk_scsi_lun_get_bdev_name ( const struct spdk_scsi_lun * lun )

Get the name of the bdev associated with the given logical unit.

Parameters

lun	Logical unit.

Returns: the name of the bdev associated with the logical unit.

◆ spdk_scsi_lun_get_dev()

const struct spdk_scsi_dev * spdk_scsi_lun_get_dev ( const struct spdk_scsi_lun * lun )

Get the SCSI device associated with the given logical unit.

Parameters

lun	Logical unit.

Returns: the SCSI device associated with the logical unit.

◆ spdk_scsi_lun_get_dif_ctx()

bool spdk_scsi_lun_get_dif_ctx	(	struct spdk_scsi_lun *	lun,
		struct spdk_scsi_task *	task,
		struct spdk_dif_ctx *	dif_ctx )

Get DIF context for SCSI LUN and SCSI command.

Parameters

lun	Logical unit.
task	SCSI task which has the payload.
dif_ctx	Output parameter which will contain initialized DIF context.

Returns: true on success or false otherwise.

◆ spdk_scsi_lun_get_id()

int spdk_scsi_lun_get_id ( const struct spdk_scsi_lun * lun )

Get the LUN id of the given logical unit.

Parameters

lun	Logical unit.

Returns: LUN id of the logical unit.

◆ spdk_scsi_lun_id_fmt_to_int()

int spdk_scsi_lun_id_fmt_to_int ( uint64_t fmt_lun )

Convert LUN ID from LUN format to integer.

Parameters

fmt_lun LUN format of LUN ID

Returns: integer LUN ID

◆ spdk_scsi_lun_id_int_to_fmt()

uint64_t spdk_scsi_lun_id_int_to_fmt ( int lun_id )

Convert LUN ID from integer to LUN format.

Parameters

lun_id Integer LUN ID

Returns: LUN format of LUN ID

◆ spdk_scsi_lun_is_removing()

bool spdk_scsi_lun_is_removing ( const struct spdk_scsi_lun * lun )

Check if the logical unit is hot removing.

Parameters

lun	Logical unit

Returns: true if removing, false otherwise.

◆ spdk_scsi_lun_open()

int spdk_scsi_lun_open	(	struct spdk_scsi_lun *	lun,
		spdk_scsi_lun_remove_cb_t	hotremove_cb,
		void *	hotremove_ctx,
		struct spdk_scsi_lun_desc **	desc )

Open a logical unit for I/O operations.

The registered callback function must get all tasks from the upper layer (e.g. iSCSI) to the LUN done, free the IO channel of the LUN if allocated, and then close the LUN.

Parameters

lun	Logical unit to open.
hotremove_cb	Callback function for hot removal of the logical unit.
hotremove_ctx	Param for hot removal callback function.
desc	Output parameter for the descriptor when operation is successful.

Returns: 0 if operation is successful, suitable errno value otherwise

◆ spdk_scsi_port_create()

struct spdk_scsi_port * spdk_scsi_port_create	(	uint64_t	id,
		uint16_t	index,
		const char *	name )

Create a new SCSI port.

Parameters

id	Port id.
index	Port index.
name	Port Name.

Returns: a pointer to the created SCSI port on success, or NULL on failure.

◆ spdk_scsi_port_free()

void spdk_scsi_port_free ( struct spdk_scsi_port ** pport )

Free the SCSI port.

Parameters

pport SCSI port to free.

◆ spdk_scsi_port_get_name()

const char * spdk_scsi_port_get_name ( const struct spdk_scsi_port * port )

Get the name of the SCSI port.

Parameters

port	SCSI port to query.

Returns: the name of the SCSI port.

◆ spdk_scsi_port_set_iscsi_transport_id()

void spdk_scsi_port_set_iscsi_transport_id	(	struct spdk_scsi_port *	port,
		char *	iscsi_name,
		uint64_t	isid )

Set iSCSI Initiator port TransportID.

Parameters

port	SCSI initiator port.
iscsi_name	Initiator name.
isid	Session ID.

◆ spdk_scsi_sbc_opcode_string()

const char * spdk_scsi_sbc_opcode_string	(	uint8_t	opcode,
		uint16_t	sa )

Translate SCSI operation code and service action into string.

Parameters

opcode	SCSI operation code
sa	SCSI service action code

Returns: SCSI operation string

◆ spdk_scsi_task_build_sense_data()

void spdk_scsi_task_build_sense_data	(	struct spdk_scsi_task *	task,
		int	sk,
		int	asc,
		int	ascq )

Build sense data for the SCSI task.

Parameters

task	SCSI task.
sk	Sense key.
asc	Additional sense code.
ascq	Additional sense code qualifier.

◆ spdk_scsi_task_construct()

void spdk_scsi_task_construct	(	struct spdk_scsi_task *	task,
		spdk_scsi_task_cpl	cpl_fn,
		spdk_scsi_task_free	free_fn )

Construct a new SCSI task.

Parameters

task	SCSI task to construct.
cpl_fn	Called when the task is completed.
free_fn	Called when the task is freed

◆ spdk_scsi_task_copy_status()

void spdk_scsi_task_copy_status	(	struct spdk_scsi_task *	dst,
		struct spdk_scsi_task *	src )

Copy SCSI status.

Parameters

dst	SCSI task whose status is written to.
src	SCSI task whose status is read from.

◆ spdk_scsi_task_gather_data()

void * spdk_scsi_task_gather_data	(	struct spdk_scsi_task *	task,
		int *	len )

Vector of buffers -> single buffer.

Parameters

task	SCSI task,
len	Length of the buffer allocated and written into.

Returns: a pointer to the buffer allocated and written into.

◆ spdk_scsi_task_process_abort()

void spdk_scsi_task_process_abort ( struct spdk_scsi_task * task )

Process the aborted SCSI task.

Parameters

task	SCSI task.

◆ spdk_scsi_task_process_null_lun()

void spdk_scsi_task_process_null_lun ( struct spdk_scsi_task * task )

Process the SCSI task when no LUN is attached.

Parameters

task	SCSI task.

◆ spdk_scsi_task_put()

void spdk_scsi_task_put ( struct spdk_scsi_task * task )

Put the SCSI task.

Parameters

task	SCSI task to put.

◆ spdk_scsi_task_scatter_data()

int spdk_scsi_task_scatter_data	(	struct spdk_scsi_task *	task,
		const void *	src,
		size_t	len )

Single buffer -> vector of buffers.

Parameters

task	SCSI task.
src	A pointer to the data buffer read from.
len	Length of the data buffer read from.

Returns: the total length of the vector of buffers written into on success, or -1 on failure.

◆ spdk_scsi_task_set_data()

void spdk_scsi_task_set_data	(	struct spdk_scsi_task *	task,
		void *	data,
		uint32_t	len )

Set internal buffer to given one.

Caller is owner of that buffer.

Parameters

task	SCSI task.
data	Pointer to buffer.
len	Buffer length.

◆ spdk_scsi_task_set_status()

void spdk_scsi_task_set_status	(	struct spdk_scsi_task *	task,
		int	sc,
		int	sk,
		int	asc,
		int	ascq )

Set SCSI status code to the SCSI task.

When the status code is CHECK CONDITION, sense data is build too.

Parameters

task	SCSI task.
sc	Sense code
sk	Sense key.
asc	Additional sense code.
ascq	Additional sense code qualifier.

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ spdk_scsi_dev_add_lun()

◆ spdk_scsi_dev_add_lun_ext()

◆ spdk_scsi_dev_add_port()

◆ spdk_scsi_dev_allocate_io_channels()

◆ spdk_scsi_dev_construct()

◆ spdk_scsi_dev_construct_ext()

◆ spdk_scsi_dev_delete_lun()

◆ spdk_scsi_dev_delete_port()

◆ spdk_scsi_dev_destruct()

◆ spdk_scsi_dev_find_port_by_id()

◆ spdk_scsi_dev_get_first_lun()

◆ spdk_scsi_dev_get_id()

◆ spdk_scsi_dev_get_lun()

◆ spdk_scsi_dev_get_name()

◆ spdk_scsi_dev_get_next_lun()

◆ spdk_scsi_dev_has_pending_tasks()

◆ spdk_scsi_dev_queue_mgmt_task()

◆ spdk_scsi_dev_queue_task()

◆ spdk_scsi_init()

◆ spdk_scsi_lun_allocate_io_channel()

◆ spdk_scsi_lun_close()

◆ spdk_scsi_lun_free_io_channel()

◆ spdk_scsi_lun_get_bdev_name()

◆ spdk_scsi_lun_get_dev()

◆ spdk_scsi_lun_get_dif_ctx()

◆ spdk_scsi_lun_get_id()

◆ spdk_scsi_lun_id_fmt_to_int()

◆ spdk_scsi_lun_id_int_to_fmt()

◆ spdk_scsi_lun_is_removing()

◆ spdk_scsi_lun_open()

◆ spdk_scsi_port_create()

◆ spdk_scsi_port_free()

◆ spdk_scsi_port_get_name()

◆ spdk_scsi_port_set_iscsi_transport_id()

◆ spdk_scsi_sbc_opcode_string()

◆ spdk_scsi_task_build_sense_data()

◆ spdk_scsi_task_construct()

◆ spdk_scsi_task_copy_status()

◆ spdk_scsi_task_gather_data()

◆ spdk_scsi_task_process_abort()

◆ spdk_scsi_task_process_null_lun()

◆ spdk_scsi_task_put()

◆ spdk_scsi_task_scatter_data()

◆ spdk_scsi_task_set_data()

◆ spdk_scsi_task_set_status()