Menu
▾
▴
[Scst-svn] SF.net SVN: scst: [337] trunk
|
From: <vl...@us...> - 2008-04-17 17:35:40
|
Revision: 337
http://scst.svn.sourceforge.net/scst/?rev=337&view=rev
Author: vlnb
Date: 2008-04-17 10:35:37 -0700 (Thu, 17 Apr 2008)
Log Message:
-----------
scsi_tgt.h renamed to scst.h
Modified Paths:
--------------
trunk/doc/scst_pg.sgml
trunk/iscsi-scst/kernel/iscsi.h
trunk/mpt/mpt_scst.c
trunk/qla2x00t/qla2x00-target/qla2x00t.c
trunk/qla_isp/linux/isp_scst.c
trunk/scst/README
trunk/scst/src/Makefile
trunk/scst/src/dev_handlers/scst_cdrom.c
trunk/scst/src/dev_handlers/scst_changer.c
trunk/scst/src/dev_handlers/scst_disk.c
trunk/scst/src/dev_handlers/scst_modisk.c
trunk/scst/src/dev_handlers/scst_processor.c
trunk/scst/src/dev_handlers/scst_raid.c
trunk/scst/src/dev_handlers/scst_tape.c
trunk/scst/src/dev_handlers/scst_user.c
trunk/scst/src/dev_handlers/scst_vdisk.c
trunk/scst/src/scst_debug.c
trunk/scst/src/scst_lib.c
trunk/scst/src/scst_main.c
trunk/scst/src/scst_mem.c
trunk/scst/src/scst_module.c
trunk/scst/src/scst_proc.c
trunk/scst/src/scst_targ.c
trunk/srpt/src/ib_srpt.h
Added Paths:
-----------
trunk/scst/include/scst.h
Removed Paths:
-------------
trunk/scst/include/scsi_tgt.h
Modified: trunk/doc/scst_pg.sgml
===================================================================
--- trunk/doc/scst_pg.sgml 2008-04-17 15:25:39 UTC (rev 336)
+++ trunk/doc/scst_pg.sgml 2008-04-17 17:35:37 UTC (rev 337)
@@ -99,7 +99,7 @@
University of New Hampshire Interoperability Labs (UNH IOL).
All described below data structures and function could be found in
-<bf/scsi_tgt.h/. The SCST's Internet page is
+<bf/scst.h/. The SCST's Internet page is
<url url="http://scst.sourceforge.net">.
<sect>Terms and Definitions
Modified: trunk/iscsi-scst/kernel/iscsi.h
===================================================================
--- trunk/iscsi-scst/kernel/iscsi.h 2008-04-17 15:25:39 UTC (rev 336)
+++ trunk/iscsi-scst/kernel/iscsi.h 2008-04-17 17:35:37 UTC (rev 337)
@@ -23,7 +23,7 @@
#include <linux/net.h>
#include <net/sock.h>
-#include <scsi_tgt.h>
+#include <scst.h>
#include "iscsi_hdr.h"
#include "iscsi_u.h"
Modified: trunk/mpt/mpt_scst.c
===================================================================
--- trunk/mpt/mpt_scst.c 2008-04-17 15:25:39 UTC (rev 336)
+++ trunk/mpt/mpt_scst.c 2008-04-17 17:35:37 UTC (rev 337)
@@ -36,7 +36,7 @@
#include <linux/pci.h>
#endif
-#include "scsi_tgt.h"
+#include "scst.h"
#include <scst_debug.h>
Modified: trunk/qla2x00t/qla2x00-target/qla2x00t.c
===================================================================
--- trunk/qla2x00t/qla2x00-target/qla2x00t.c 2008-04-17 15:25:39 UTC (rev 336)
+++ trunk/qla2x00t/qla2x00-target/qla2x00t.c 2008-04-17 17:35:37 UTC (rev 337)
@@ -31,7 +31,7 @@
#include <linux/seq_file.h>
#include <linux/list.h>
-#include <scsi_tgt.h>
+#include <scst.h>
/* Necessary to have equal structures with the initiator */
#if defined(FC_IP_SUPPORT)
Modified: trunk/qla_isp/linux/isp_scst.c
===================================================================
--- trunk/qla_isp/linux/isp_scst.c 2008-04-17 15:25:39 UTC (rev 336)
+++ trunk/qla_isp/linux/isp_scst.c 2008-04-17 17:35:37 UTC (rev 337)
@@ -88,7 +88,7 @@
#include <linux/seq_file.h>
#include <scsi/scsi_host.h>
-#include <scsi_tgt.h>
+#include <scst.h>
#include <scst_debug.h>
#ifdef min
Modified: trunk/scst/README
===================================================================
--- trunk/scst/README 2008-04-17 15:25:39 UTC (rev 336)
+++ trunk/scst/README 2008-04-17 17:35:37 UTC (rev 337)
@@ -62,7 +62,7 @@
To compile SCST type 'make scst'. It will build SCST itself and its
device handlers. To install them type 'make scst_install'. The driver
modules will be installed in '/lib/modules/`you_kernel_version`/extra'.
-In addition, scsi_tgt.h, scst_debug.h as well as Module.symvers or
+In addition, scst.h, scst_debug.h as well as Module.symvers or
Modules.symvers will be copied to '/usr/local/include/scst'. The first
file contains all SCST's public data definition, which are used by
target drivers. The other ones support debug messages logging and build
Deleted: trunk/scst/include/scsi_tgt.h
===================================================================
--- trunk/scst/include/scsi_tgt.h 2008-04-17 15:25:39 UTC (rev 336)
+++ trunk/scst/include/scsi_tgt.h 2008-04-17 17:35:37 UTC (rev 337)
@@ -1,2734 +0,0 @@
-/*
- * include/scsi_tgt.h
- *
- * Copyright (C) 2004-2007 Vladislav Bolkhovitin <vs...@vl...>
- * and Leonid Stoljar
- *
- * Main SCSI target mid-level include file.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation, version 2
- * of the License.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- */
-
-#ifndef __SCST_H
-#define __SCST_H
-
-#include <linux/types.h>
-#include <linux/version.h>
-#include <linux/blkdev.h>
-#include <linux/interrupt.h>
-#include <linux/proc_fs.h>
-
-#ifdef SCST_HIGHMEM
-#include <asm/kmap_types.h>
-#endif
-#include <scsi/scsi_cmnd.h>
-#include <scsi/scsi_device.h>
-#include <scsi/scsi_eh.h>
-#include <scsi/scsi.h>
-
-#include <scst_const.h>
-
-#ifndef DECLARE_MUTEX_LOCKED
-#define DECLARE_MUTEX_LOCKED(name) __DECLARE_SEMAPHORE_GENERIC(name, 0)
-#endif
-
-#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,19)
-typedef _Bool bool;
-#endif
-
-/* Version numbers, the same as for the kernel */
-#define SCST_VERSION_CODE 0x00090601
-#define SCST_VERSION(a,b,c,d) (((a) << 24) + ((b) << 16) + ((c) << 8) + d)
-#define SCST_VERSION_STRING "0.9.6-rc1"
-#define SCST_INTERFACE_VERSION SCST_VERSION_STRING "$Revision$" SCST_CONST_VERSION
-
-/*************************************************************
- ** States of command processing state machine. At first,
- ** "active" states, then - "passive" ones. This is to have
- ** more efficient generated code of the corresponding
- ** "switch" statements.
- *************************************************************/
-
-/* Internal parsing */
-#define SCST_CMD_STATE_PRE_PARSE 0
-
-/* Dev handler's parse() is going to be called */
-#define SCST_CMD_STATE_DEV_PARSE 1
-
-/* Allocation of the cmd's data buffer */
-#define SCST_CMD_STATE_PREPARE_SPACE 2
-
-/* Target driver's rdy_to_xfer() is going to be called */
-#define SCST_CMD_STATE_RDY_TO_XFER 3
-
-/* Target driver's pre_exec() is going to be called */
-#define SCST_CMD_STATE_TGT_PRE_EXEC 4
-
-/* CDB is going to be sent to SCSI mid-level for execution */
-#define SCST_CMD_STATE_SEND_TO_MIDLEV 5
-
-/* Internal pos-exec checks */
-#define SCST_CMD_STATE_PRE_DEV_DONE 6
-
-/* Internal MODE SELECT pages related checks */
-#define SCST_CMD_STATE_MODE_SELECT_CHECKS 7
-
-/* Dev handler's dev_done() is going to be called */
-#define SCST_CMD_STATE_DEV_DONE 8
-
-/* Target driver's xmit_response() is going to be called */
-#define SCST_CMD_STATE_PRE_XMIT_RESP 9
-
-/* Target driver's xmit_response() is going to be called */
-#define SCST_CMD_STATE_XMIT_RESP 10
-
-/* The cmd finished */
-#define SCST_CMD_STATE_FINISHED 11
-
-#define SCST_CMD_STATE_LAST_ACTIVE (SCST_CMD_STATE_FINISHED+100)
-
-
-/* A cmd is created, but scst_cmd_init_done() not called */
-#define SCST_CMD_STATE_INIT_WAIT (SCST_CMD_STATE_LAST_ACTIVE+1)
-
-/* LUN translation (cmd->tgt_dev assignment) */
-#define SCST_CMD_STATE_INIT (SCST_CMD_STATE_LAST_ACTIVE+2)
-
-/* Allocation of the cmd's data buffer */
-#define SCST_CMD_STATE_PREPROCESS_DONE (SCST_CMD_STATE_LAST_ACTIVE+3)
-
-/* Waiting for data from the initiator (until scst_rx_data() called) */
-#define SCST_CMD_STATE_DATA_WAIT (SCST_CMD_STATE_LAST_ACTIVE+4)
-
-/* Waiting for CDB's execution finish */
-#define SCST_CMD_STATE_EXECUTING (SCST_CMD_STATE_LAST_ACTIVE+5)
-
-/* Waiting for response's transmission finish */
-#define SCST_CMD_STATE_XMIT_WAIT (SCST_CMD_STATE_LAST_ACTIVE+6)
-
-/*************************************************************
- * Can be retuned instead of cmd's state by dev handlers'
- * functions, if the command's state should be set by default
- *************************************************************/
-#define SCST_CMD_STATE_DEFAULT 500
-
-/*************************************************************
- * Can be retuned instead of cmd's state by dev handlers'
- * functions, if it is impossible to complete requested
- * task in atomic context. The cmd will be restarted in thread
- * context.
- *************************************************************/
-#define SCST_CMD_STATE_NEED_THREAD_CTX 1000
-
-/*************************************************************
- * Can be retuned instead of cmd's state by dev handlers'
- * parse function, if the cmd processing should be stopped
- * for now. The cmd will be restarted by dev handlers itself.
- *************************************************************/
-#define SCST_CMD_STATE_STOP 1001
-
-/*************************************************************
- ** States of mgmt command processing state machine
- *************************************************************/
-
-/* LUN translation (mcmd->tgt_dev assignment) */
-#define SCST_MGMT_CMD_STATE_INIT 0
-
-/* Mgmt cmd is ready for processing */
-#define SCST_MGMT_CMD_STATE_READY 1
-
-/* Mgmt cmd is being executing */
-#define SCST_MGMT_CMD_STATE_EXECUTING 2
-
-/* Reservations are going to be cleared, if necessary */
-#define SCST_MGMT_CMD_STATE_CHECK_NEXUS_LOSS 3
-
-/* Target driver's task_mgmt_fn_done() is going to be called */
-#define SCST_MGMT_CMD_STATE_DONE 4
-
-/* The mcmd finished */
-#define SCST_MGMT_CMD_STATE_FINISHED 5
-
-/*************************************************************
- ** Constants for "atomic" parameter of SCST's functions
- *************************************************************/
-#define SCST_NON_ATOMIC 0
-#define SCST_ATOMIC 1
-
-/*************************************************************
- ** Values for pref_context parameter of scst_cmd_init_done() and
- ** scst_rx_data()
- *************************************************************/
-
-/*
- * Direct cmd's processing (i.e. regular function calls in the current
- * context) sleeping is not allowed
- */
-#define SCST_CONTEXT_DIRECT_ATOMIC 0
-
-/*
- * Direct cmd's processing (i.e. regular function calls in the current
- * context), sleeping is allowed, no restrictions
- */
-#define SCST_CONTEXT_DIRECT 1
-
-/* Tasklet or thread context required for cmd's processing */
-#define SCST_CONTEXT_TASKLET 2
-
-/* Thread context required for cmd's processing */
-#define SCST_CONTEXT_THREAD 3
-
-/*
- * SCST internal flag, which specifies that context is processable, i.e. the
- * next command in the active list will be processed after the current one.
- *
- * Target drivers must never use it!!
- */
-#define SCST_CONTEXT_PROCESSABLE 0x100
-
-/*************************************************************
- ** Values for status parameter of scst_rx_data()
- *************************************************************/
-
-/* Success */
-#define SCST_RX_STATUS_SUCCESS 0
-
-/*
- * Data receiving finished with error, so set the sense and
- * finish the command, including xmit_response() call
- */
-#define SCST_RX_STATUS_ERROR 1
-
-/*
- * Data receiving finished with error and the sense is set,
- * so finish the command, including xmit_response() call
- */
-#define SCST_RX_STATUS_ERROR_SENSE_SET 2
-
-/*
- * Data receiving finished with fatal error, so finish the command,
- * but don't call xmit_response()
- */
-#define SCST_RX_STATUS_ERROR_FATAL 3
-
-/*************************************************************
- ** Values for status parameter of scst_restart_cmd()
- *************************************************************/
-
-/* Success */
-#define SCST_PREPROCESS_STATUS_SUCCESS 0
-
-/*
- * Command's processing finished with error, so set the sense and
- * finish the command, including xmit_response() call
- */
-#define SCST_PREPROCESS_STATUS_ERROR 1
-
-/*
- * Command's processing finished with error and the sense is set,
- * so finish the command, including xmit_response() call
- */
-#define SCST_PREPROCESS_STATUS_ERROR_SENSE_SET 2
-
-/*
- * Command's processing finished with fatal error, so finish the command,
- * but don't call xmit_response()
- */
-#define SCST_PREPROCESS_STATUS_ERROR_FATAL 3
-
-/* Thread context requested */
-#define SCST_PREPROCESS_STATUS_NEED_THREAD 4
-
-/*************************************************************
- ** Allowed return codes for xmit_response(), rdy_to_xfer(),
- ** report_aen()
- *************************************************************/
-
-/* Success */
-#define SCST_TGT_RES_SUCCESS 0
-
-/* Internal device queue is full, retry again later */
-#define SCST_TGT_RES_QUEUE_FULL -1
-
-/*
- * It is impossible to complete requested task in atomic context.
- * The cmd will be restarted in thread context.
- */
-#define SCST_TGT_RES_NEED_THREAD_CTX -2
-
-/*
- * Fatal error, if returned by xmit_response() the cmd will
- * be destroyed, if by any other function, xmit_response()
- * will be called with HARDWARE ERROR sense data
- */
-#define SCST_TGT_RES_FATAL_ERROR -3
-
-/*************************************************************
- ** Allowed return codes for dev handler's exec()
- *************************************************************/
-
-/* The cmd is done, go to other ones */
-#define SCST_EXEC_COMPLETED 0
-
-/* The cmd should be sent to SCSI mid-level */
-#define SCST_EXEC_NOT_COMPLETED 1
-
-/*
- * Thread context is required to execute the command.
- * Exec() will be called again in the thread context.
- */
-#define SCST_EXEC_NEED_THREAD 2
-
-/*************************************************************
- ** Default timeout for cmd's CDB execution
- ** by SCSI mid-level (cmd's "timeout" field).
- *************************************************************/
-#define SCST_DEFAULT_TIMEOUT (30*HZ)
-
-/*************************************************************
- ** Flags of cmd->tgt_resp_flags
- *************************************************************/
-
-/*
- * Set if cmd is finished and there is status/sense to be sent.
- * The status should be not sent (i.e. the flag not set) if the
- * possibility to perform a command in "chunks" (i.e. with multiple
- * xmit_response()/rdy_to_xfer()) is used (not implemented and,
- * probably, will never be).
- */
-#define SCST_TSC_FLAG_STATUS 0x2
-
-/*************************************************************
- ** Additional return code for dev handler's task_mgmt_fn()
- *************************************************************/
-
-/* Regular standard actions for the command should be done */
-#define SCST_DEV_TM_NOT_COMPLETED 1
-
-/*************************************************************
- ** Session initialization phases
- *************************************************************/
-
-/* Set if session is being initialized */
-#define SCST_SESS_IPH_INITING 0
-
-/* Set if the session is successfully initialized */
-#define SCST_SESS_IPH_SUCCESS 1
-
-/* Set if the session initialization failed */
-#define SCST_SESS_IPH_FAILED 2
-
-/* Set if session is initialized and ready */
-#define SCST_SESS_IPH_READY 3
-
-/*************************************************************
- ** Session shutdown phases
- *************************************************************/
-
-/* Set if session is initialized and ready */
-#define SCST_SESS_SPH_READY 0
-
-/* Set if session is on calling pre_unreg_sess() phase */
-#define SCST_SESS_SPH_PRE_UNREG 1
-
-/* Set if session is shutting down */
-#define SCST_SESS_SPH_SHUTDOWN 2
-
-/*************************************************************
- ** Cmd's async (atomic) flags
- *************************************************************/
-
-/* Set if the cmd is aborted and ABORTED sense will be sent as the result */
-#define SCST_CMD_ABORTED 0
-
-/* Set if the cmd is aborted by other initiator */
-#define SCST_CMD_ABORTED_OTHER 1
-
-/* Set if no response should be sent to the target about this cmd */
-#define SCST_CMD_NO_RESP 2
-
-/* Set if the cmd is dead and can be destroyed at any time */
-#define SCST_CMD_CAN_BE_DESTROYED 3
-
-/*************************************************************
- ** Tgt_dev's flags (tgt_dev_flags)
- *************************************************************/
-
-/* Set if tgt_dev has Unit Attention sense */
-#define SCST_TGT_DEV_UA_PENDING 0
-
-/* Set if tgt_dev is RESERVED by another session */
-#define SCST_TGT_DEV_RESERVED 1
-
-/* Set if the corresponding context is atomic */
-#define SCST_TGT_DEV_AFTER_INIT_WR_ATOMIC 5
-#define SCST_TGT_DEV_AFTER_INIT_OTH_ATOMIC 6
-#define SCST_TGT_DEV_AFTER_RESTART_WR_ATOMIC 7
-#define SCST_TGT_DEV_AFTER_RESTART_OTH_ATOMIC 8
-#define SCST_TGT_DEV_AFTER_RX_DATA_ATOMIC 9
-#define SCST_TGT_DEV_AFTER_EXEC_ATOMIC 10
-
-#ifdef DEBUG_TM
-#define SCST_TGT_DEV_UNDER_TM_DBG 20
-#endif
-
-/*************************************************************
- ** Name of the entry in /proc
- *************************************************************/
-#define SCST_PROC_ENTRY_NAME "scsi_tgt"
-
-/*************************************************************
- ** Kernel cache creation helper
- *************************************************************/
-#ifndef KMEM_CACHE
-#define KMEM_CACHE(__struct, __flags) kmem_cache_create(#__struct,\
- sizeof(struct __struct), __alignof__(struct __struct),\
- (__flags), NULL, NULL)
-#endif
-
-/*************************************************************
- * TYPES
- *************************************************************/
-
-struct scst_tgt;
-struct scst_session;
-struct scst_cmd;
-struct scst_mgmt_cmd;
-struct scst_device;
-struct scst_tgt_dev;
-struct scst_dev_type;
-struct scst_acg;
-struct scst_acg_dev;
-struct scst_acn;
-
-typedef uint64_t lun_t;
-
-typedef enum dma_data_direction scst_data_direction;
-
-enum scst_cdb_flags
-{
- SCST_TRANSFER_LEN_TYPE_FIXED = 0x01, /* must be equviv 1 (FIXED_BIT in cdb) */
- SCST_SMALL_TIMEOUT = 0x02,
- SCST_LONG_TIMEOUT = 0x04,
- SCST_UNKNOWN_LENGTH = 0x08,
- SCST_INFO_INVALID = 0x10,
-};
-
-/*
- * Scsi_Target_Template: defines what functions a target driver will
- * have to provide in order to work with the target mid-level.
- * MUST HAVEs define functions that are expected to be in order to work.
- * OPTIONAL says that there is a choice.
- * Also, pay attention to the fact that a command is BLOCKING or NON-BLOCKING.
- * NON-BLOCKING means that a function returns immediately and will not wait
- * for actual data transfer to finish. Blocking in such command could have
- * negative impact on overall system performance. If blocking is necessary,
- * it is worth to consider creating dedicated thread(s) in target driver, to
- * which the commands would be passed and which would perform blocking
- * operations instead of SCST.
- * If the function allowed to sleep or not is determined by its last
- * argument, which is true, if sleeping is not allowed. In this case,
- * if the function requires sleeping, it can return
- * SCST_TGT_RES_NEED_THREAD_CTX, and it will be recalled in the thread context,
- * where sleeping is allowed.
- */
-struct scst_tgt_template
-{
- /* public: */
-
- /*
- * SG tablesize allows to check whether scatter/gather can be used
- * or not.
- */
- int sg_tablesize;
-
- /*
- * True, if this target adapter uses unchecked DMA onto an ISA bus.
- */
- unsigned unchecked_isa_dma:1;
-
- /*
- * True, if this target adapter can benefit from using SG-vector
- * clustering (i.e. smaller number of segments).
- */
- unsigned use_clustering:1;
-
- /*
- * True, if this target adapter doesn't support SG-vector clustering
- */
- unsigned no_clustering:1;
-
- /*
- * True, if corresponding function supports execution in
- * the atomic (non-sleeping) context
- */
- unsigned xmit_response_atomic:1;
- unsigned rdy_to_xfer_atomic:1;
- unsigned preprocessing_done_atomic:1;
-
- /* True, if the template doesn't need the entry in /proc */
- unsigned no_proc_entry:1;
-
- /*
- * This function is equivalent to the SCSI
- * queuecommand. The target should transmit the response
- * buffer and the status in the scst_cmd struct.
- * The expectation is that this executing this command is NON-BLOCKING.
- *
- * After the response is actually transmitted, the target
- * should call the scst_tgt_cmd_done() function of the
- * mid-level, which will allow it to free up the command.
- * Returns one of the SCST_TGT_RES_* constants.
- *
- * Pay attention to "atomic" attribute of the cmd, which can be get
- * by scst_cmd_atomic(): it is true if the function called in the
- * atomic (non-sleeping) context.
- *
- * MUST HAVE
- */
- int (*xmit_response) (struct scst_cmd *cmd);
-
- /*
- * This function informs the driver that data
- * buffer corresponding to the said command have now been
- * allocated and it is OK to receive data for this command.
- * This function is necessary because a SCSI target does not
- * have any control over the commands it receives. Most lower
- * level protocols have a corresponding function which informs
- * the initiator that buffers have been allocated e.g., XFER_
- * RDY in Fibre Channel. After the data is actually received
- * the low-level driver needs to call scst_rx_data() in order to
- * continue processing this command.
- * Returns one of the SCST_TGT_RES_* constants.
- * This command is expected to be NON-BLOCKING.
- *
- * Pay attention to "atomic" attribute of the cmd, which can be get
- * by scst_cmd_atomic(): it is true if the function called in the
- * atomic (non-sleeping) context.
- *
- * OPTIONAL
- */
- int (*rdy_to_xfer) (struct scst_cmd *cmd);
-
- /*
- * Called to notify the driver that the command is about to be freed.
- * Necessary, because for aborted commands xmit_response() could not
- * be called. Could be called on IRQ context.
- *
- * OPTIONAL
- */
- void (*on_free_cmd) (struct scst_cmd *cmd);
-
- /*
- * This function allows target driver to handle data buffer
- * allocations on its own.
- *
- * Target driver doesn't have to always allocate buffer in this
- * function, but if it decide to do it, it must check that
- * scst_cmd_get_data_buff_alloced() returns 0, otherwise to avoid
- * double buffer allocation and memory leaks alloc_data_buf() shall
- * fail.
- *
- * Shall return 0 in case of success or < 0 (preferrably -ENOMEM)
- * in case of error, or > 0 if the regular SCST allocation should be
- * done. In case of returning successfully, scst_cmd->data_buf_alloced
- * will be set by SCST.
- *
- * If allocation in atomic context - cf. scst_cmd_atomic() - is not
- * desired or fails and consequently < 0 is returned, this function
- * will be re-called in thread context.
- *
- * Please note that the driver will have to handle itself all relevant
- * details such as scatterlist setup, highmem, freeing the allocated
- * memory, etc.
- *
- * OPTIONAL.
- */
- int (*alloc_data_buf) (struct scst_cmd *cmd);
-
- /*
- * This function informs the driver that data
- * buffer corresponding to the said command have now been
- * allocated and other preprocessing tasks have been done.
- * A target driver could need to do some actions at this stage.
- * After the target driver done the needed actions, it shall call
- * scst_restart_cmd() in order to continue processing this command.
- *
- * Called only if the cmd is queued using scst_cmd_init_stage1_done()
- * instead of scst_cmd_init_done().
- *
- * Returns void, the result is expected to be returned using
- * scst_restart_cmd().
- *
- * This command is expected to be NON-BLOCKING.
- *
- * Pay attention to "atomic" attribute of the cmd, which can be get
- * by scst_cmd_atomic(): it is true if the function called in the
- * atomic (non-sleeping) context.
- *
- * OPTIONAL.
- */
- void (*preprocessing_done) (struct scst_cmd *cmd);
-
- /*
- * This function informs the driver that the said command is about
- * to be executed.
- *
- * Returns one of the SCST_PREPROCESS_* constants.
- *
- * This command is expected to be NON-BLOCKING.
- *
- * Pay attention to "atomic" attribute of the cmd, which can be get
- * by scst_cmd_atomic(): it is true if the function called in the
- * atomic (non-sleeping) context.
- *
- * OPTIONAL
- */
- int (*pre_exec) (struct scst_cmd *cmd);
-
- /*
- * This function informs the driver that a
- * received task management function has been completed. This
- * function is necessary because low-level protocols have some
- * means of informing the initiator about the completion of a
- * Task Management function. This function being called will
- * signify that a Task Management function is completed as far
- * as the mid-level is concerned. Any information that must be
- * stored about the command is the responsibility of the low-
- * level driver. No return value expected.
- * This function is expected to be NON-BLOCKING
- *
- * Called without any locks held from a thread context.
- *
- * MUST HAVE if the target supports ABORTs
- */
- void (*task_mgmt_fn_done) (struct scst_mgmt_cmd *mgmt_cmd);
-
- /*
- * This function should detect the target adapters that
- * are present in the system. The function should return a value
- * >= 0 to signify the number of detected target adapters.
- * A negative value should be returned whenever there is
- * an error.
- *
- * MUST HAVE
- */
- int (*detect) (struct scst_tgt_template *tgt_template);
-
- /*
- * This function should free up the resources allocated to the device.
- * The function should return 0 to indicate successful release
- * or a negative value if there are some issues with the release.
- * In the current version the return value is ignored.
- *
- * MUST HAVE
- */
- int (*release) (struct scst_tgt *tgt);
-
- /*
- * This function is used for Asynchronous Event Notification.
- * It is the responsibility of the driver to notify any/all
- * initiators about the Asynchronous Event reported.
- * Returns one of the SCST_TGT_RES_* constants.
- * This command is expected to be NON-BLOCKING, but can sleep.
- *
- * MUST HAVE if low-level protocol supports AEN
- *
- * ToDo
- */
- int (*report_aen) (int mgmt_fn, const uint8_t *lun, int lun_len);
-
- /*
- * Those functions can be used to export the driver's statistics and
- * other infos to the world outside the kernel as well as to get some
- * management commands from it.
- *
- * OPTIONAL
- */
- int (*read_proc) (struct seq_file *seq, struct scst_tgt *tgt);
- int (*write_proc) (char *buffer, char **start, off_t offset,
- int length, int *eof, struct scst_tgt *tgt);
-
- /*
- * Name of the template. Must be unique to identify
- * the template. MUST HAVE
- */
- const char name[50];
-
- /*
- * Number of additional threads to the pool of dedicated threads.
- * Used if xmit_response() or rdy_to_xfer() is blocking.
- * It is the target driver's duty to ensure that not more, than that
- * number of threads, are blocked in those functions at any time.
- */
- int threads_num;
-
- /* Private, must be inited to 0 by memset() */
-
- /* List of targets per template, protected by scst_mutex */
- struct list_head tgt_list;
-
- /* List entry of global templates list */
- struct list_head scst_template_list_entry;
-
- /* The pointer to the /proc directory entry */
- struct proc_dir_entry *proc_tgt_root;
-
- /* Device number in /proc */
- int proc_dev_num;
-};
-
-struct scst_dev_type
-{
- /* SCSI type of the supported device. MUST HAVE */
- int type;
-
- /*
- * True, if corresponding function supports execution in
- * the atomic (non-sleeping) context
- */
- unsigned parse_atomic:1;
- unsigned exec_atomic:1;
- unsigned dev_done_atomic:1;
-
- /* Set, if no /proc files should be automatically created by SCST */
- unsigned no_proc:1;
-
- /* Set, if exec() is synchronous */
- unsigned exec_sync:1;
-
- /*
- * Called to parse CDB from the cmd and initialize
- * cmd->bufflen and cmd->data_direction (both - REQUIRED).
- * Returns the command's next state or SCST_CMD_STATE_DEFAULT,
- * if the next default state should be used, or
- * SCST_CMD_STATE_NEED_THREAD_CTX if the function called in atomic
- * context, but requires sleeping, or SCST_CMD_STATE_STOP if the
- * command should not be further processed for now. In the
- * SCST_CMD_STATE_NEED_THREAD_CTX case the function
- * will be recalled in the thread context, where sleeping is allowed.
- *
- * Pay attention to "atomic" attribute of the cmd, which can be get
- * by scst_cmd_atomic(): it is true if the function called in the
- * atomic (non-sleeping) context.
- *
- * MUST HAVE
- */
- int (*parse) (struct scst_cmd *cmd);
-
- /*
- * Called to execute CDB. Useful, for instance, to implement
- * data caching. The result of CDB execution is reported via
- * cmd->scst_cmd_done() callback.
- * Returns:
- * - SCST_EXEC_COMPLETED - the cmd is done, go to other ones
- * - SCST_EXEC_NEED_THREAD - thread context is required to execute
- * the command. Exec() will be called again in the thread context.
- * - SCST_EXEC_NOT_COMPLETED - the cmd should be sent to SCSI mid-level.
- *
- * Pay attention to "atomic" attribute of the cmd, which can be get
- * by scst_cmd_atomic(): it is true if the function called in the
- * atomic (non-sleeping) context.
- *
- * If this function provides sync execution, you must set above
- * exec_sync flag and should consider to setup dedicated threads by
- * setting threads_num > 0.
- *
- * !! If this function is implemented, scst_check_local_events() shall !!
- * !! be called inside it just before the actual command's execution. !!
- *
- * OPTIONAL, if not set, the commands will be sent directly to SCSI
- * device.
- */
- int (*exec) (struct scst_cmd *cmd);
-
- /*
- * Called to notify dev handler about the result of cmd execution
- * and perform some post processing. Cmd's fields tgt_resp_flags and
- * resp_data_len should be set by this function, but SCST offers good
- * defaults.
- * Returns the command's next state or SCST_CMD_STATE_DEFAULT,
- * if the next default state should be used, or
- * SCST_CMD_STATE_NEED_THREAD_CTX if the function called in atomic
- * context, but requires sleeping. In the last case, the function
- * will be recalled in the thread context, where sleeping is allowed.
- *
- * Pay attention to "atomic" attribute of the cmd, which can be get
- * by scst_cmd_atomic(): it is true if the function called in the
- * atomic (non-sleeping) context.
- */
- int (*dev_done) (struct scst_cmd *cmd);
-
- /*
- * Called to notify dev hander that the command is about to be freed.
- * Could be called on IRQ context.
- */
- void (*on_free_cmd) (struct scst_cmd *cmd);
-
- /*
- * Called to execute a task management command.
- * Returns:
- * - SCST_MGMT_STATUS_SUCCESS - the command is done with success,
- * no firther actions required
- * - The SCST_MGMT_STATUS_* error code if the command is failed and
- * no firther actions required
- * - SCST_DEV_TM_NOT_COMPLETED - regular standard actions for the command
- * should be done
- *
- * Called without any locks held from a thread context.
- */
- int (*task_mgmt_fn) (struct scst_mgmt_cmd *mgmt_cmd,
- struct scst_tgt_dev *tgt_dev);
-
- /*
- * Called when new device is attaching to the dev handler
- * Returns 0 on success, error code otherwise.
- */
- int (*attach) (struct scst_device *dev);
-
- /* Called when new device is detaching from the dev handler */
- void (*detach) (struct scst_device *dev);
-
- /*
- * Called when new tgt_dev (session) is attaching to the dev handler.
- * Returns 0 on success, error code otherwise.
- */
- int (*attach_tgt) (struct scst_tgt_dev *tgt_dev);
-
- /*
- * Called when a session, corresponding to a tgt_dev, is about to be
- * unregistered and the tgt_dev - detached. Supposed to be used to
- * clean out "stalled" commands, which otherwise could prevent SCST
- * from entering into the suspended activity state and, so,
- * unregistering the device.
- */
- void (*pre_unreg_sess) (struct scst_tgt_dev *tgt_dev);
-
- /* Called when tgt_dev (session) is detaching from the dev handler */
- void (*detach_tgt) (struct scst_tgt_dev *tgt_dev);
-
- /*
- * Those functions can be used to export the handler's statistics and
- * other infos to the world outside the kernel as well as to get some
- * management commands from it.
- *
- * OPTIONAL
- */
- int (*read_proc) (struct seq_file *seq, struct scst_dev_type *dev_type);
- int (*write_proc) (char *buffer, char **start, off_t offset,
- int length, int *eof, struct scst_dev_type *dev_type);
-
- /* Name of the dev handler. Must be unique. MUST HAVE */
- char name[15];
-
- /*
- * Number of dedicated threads. If 0 - no dedicated threads will
- * be created, if <0 - creation of dedicated threads is prohibited.
- */
- int threads_num;
-
- struct module *module;
-
- /* private: */
-
- /* list entry in scst_dev_type_list */
- struct list_head dev_type_list_entry;
-
- /* The pointer to the /proc directory entry */
- struct proc_dir_entry *proc_dev_type_root;
-};
-
-struct scst_tgt
-{
- /* List of remote sessions per target, protected by scst_mutex */
- struct list_head sess_list;
-
- /* List entry of targets per template (tgts_list) */
- struct list_head tgt_list_entry;
-
- struct scst_tgt_template *tgtt; /* corresponding target template */
-
- /* Used to wait until session finished to unregister */
- wait_queue_head_t unreg_waitQ;
-
- /* Device number in /proc */
- int proc_num;
-
- /*
- * The following fields used to store and retry cmds if
- * target's internal queue is full, so the target is unable to accept
- * the cmd returning QUEUE FULL
- */
- atomic_t finished_cmds;
- int retry_cmds; /* protected by tgt_lock */
- spinlock_t tgt_lock;
- struct list_head retry_cmd_list; /* protected by tgt_lock */
- struct timer_list retry_timer;
- int retry_timer_active;
-
- /*
- * Maximum SG table size. Needed here, since different cards on the
- * same target template can have different SG table limitations.
- */
- int sg_tablesize;
-
- /* Used for storage of target driver private stuff */
- void *tgt_priv;
-
- /* Name on the default security group ("Default_target_name") */
- char *default_group_name;
-};
-
-/* Hash size and hash fn for hash based lun translation */
-#define TGT_DEV_HASH_SHIFT 5
-#define TGT_DEV_HASH_SIZE (1<<TGT_DEV_HASH_SHIFT)
-#define HASH_VAL(_val) (_val & (TGT_DEV_HASH_SIZE - 1))
-
-struct scst_session
-{
- /*
- * Initialization phase, one of SCST_SESS_IPH_* constants, protected by
- * sess_list_lock
- */
- int init_phase;
-
- atomic_t refcnt; /* get/put counter */
-
- /**************************************************************/
-
- /* Alive commands for this session. ToDo: make it part of the common IO flow control */
- atomic_t sess_cmd_count;
-
- spinlock_t sess_list_lock; /* protects search_cmd_list, etc */
-
- /*
- * List of cmds in this session. Used to find a cmd in the
- * session. Protected by sess_list_lock.
- */
- struct list_head search_cmd_list;
-
- /*
- * Hash list of tgt_dev's for this session, protected by scst_mutex
- * and suspended activity
- */
- struct list_head sess_tgt_dev_list_hash[TGT_DEV_HASH_SIZE];
-
- /* Access control for this session and list entry there */
- struct scst_acg *acg;
-
- /* List entry for the sessions list inside ACG */
- struct list_head acg_sess_list_entry;
-
- struct scst_tgt *tgt; /* corresponding target */
-
- /* Used for storage of target driver private stuff */
- void *tgt_priv;
-
- /* Name of attached initiator */
- const char *initiator_name;
-
- /* List entry of sessions per target */
- struct list_head sess_list_entry;
-
- /* List entry for the list that keeps session, waiting for the init */
- struct list_head sess_init_list_entry;
-
- /* List entry for the list that keeps session, waiting for the shutdown */
- struct list_head sess_shut_list_entry;
-
- /*
- * Lists of deffered during session initialization commands.
- * Protected by sess_list_lock.
- */
- struct list_head init_deferred_cmd_list;
- struct list_head init_deferred_mcmd_list;
-
- /*
- * Shutdown phase, one of SCST_SESS_SPH_* constants, unprotected.
- * Async. relating to init_phase, must be a separate variable, because
- * session could be unregistered before async. registration is finished.
- */
- unsigned long shut_phase;
-
- /* Used if scst_unregister_session() called in wait mode */
- struct completion *shutdown_compl;
-
- /*
- * Functions and data for user callbacks from scst_register_session()
- * and scst_unregister_session()
- */
- void *reg_sess_data;
- void (*init_result_fn) (struct scst_session *sess, void *data,
- int result);
- void (*unreg_done_fn) (struct scst_session *sess);
- void (*unreg_cmds_done_fn) (struct scst_session *sess);
-
-#ifdef MEASURE_LATENCY /* must be last */
- spinlock_t meas_lock;
- uint64_t scst_time, processing_time;
- unsigned int processed_cmds;
-#endif
-};
-
-struct scst_cmd_lists
-{
- spinlock_t cmd_list_lock;
- struct list_head active_cmd_list;
- wait_queue_head_t cmd_list_waitQ;
- struct list_head lists_list_entry;
-};
-
-struct scst_cmd
-{
- /* List entry for below *_cmd_lists */
- struct list_head cmd_list_entry;
-
- /* Pointer to lists of commands with the lock */
- struct scst_cmd_lists *cmd_lists;
-
- atomic_t cmd_ref;
-
- struct scst_session *sess; /* corresponding session */
-
- /* Cmd state, one of SCST_CMD_STATE_* constants */
- int state;
-
- /*************************************************************
- ** Cmd's flags
- *************************************************************/
- /*
- * Set if expected_sn was incremented, i.e. cmd was sent to
- * SCSI mid-level for execution
- */
- unsigned int sent_to_midlev:1;
-
- /* Set if scst_local_exec() was already called for this cmd */
- unsigned int local_exec_done:1;
-
- /* Set if the cmd's action is completed */
- unsigned int completed:1;
-
- /* Set if we should ignore Unit Attention in scst_check_sense() */
- unsigned int ua_ignore:1;
-
- /* Set if cmd is being processed in atomic context */
- unsigned int atomic:1;
-
- /*
- * Set if the cmd is being processed in the processable context. See
- * comment for SCST_CONTEXT_PROCESSABLE for what it means.
- */
- unsigned int context_processable:1;
-
- /* Set if cmd is internally generated */
- unsigned int internal:1;
-
- /* Set if cmd is being retried */
- unsigned int retry:1;
-
- /* Set if the device was blocked by scst_inc_on_dev_cmd() (for debug) */
- unsigned int inc_blocking:1;
-
- /* Set if the device should be unblocked after cmd's finish */
- unsigned int needs_unblocking:1;
-
- /* Set if scst_dec_on_dev_cmd() call is needed on the cmd's finish */
- unsigned int dec_on_dev_needed:1;
-
- /*
- * Set if the target driver wants to alloc data buffers on its own.
- * In this case alloc_data_buf() must be provided in the target driver
- * template.
- */
- unsigned int data_buf_tgt_alloc:1;
-
- /*
- * Set by SCST if the custom data buffer allocation by the target driver
- * succeeded.
- */
- unsigned int data_buf_alloced:1;
-
- /* Set if the target driver called scst_set_expected() */
- unsigned int expected_values_set:1;
-
- /*
- * Set if the cmd was delayed by task management debugging code.
- * Used only if DEBUG_TM is on.
- */
- unsigned int tm_dbg_delayed:1;
-
- /*
- * Set if the cmd must be ignored by task management debugging code.
- * Used only if DEBUG_TM is on.
- */
- unsigned int tm_dbg_immut:1;
-
- /*
- * Set if the SG buffer was modified by scst_set_resp_data_len()
- */
- unsigned int sg_buff_modified:1;
-
- /*
- * Set if scst_cmd_init_stage1_done() called and the target
- * want that preprocessing_done() will be called
- */
- unsigned int preprocessing_only:1;
-
- /* Set if cmd's SN was set */
- unsigned int sn_set:1;
-
- /* Set if hq_cmd_count was incremented */
- unsigned int hq_cmd_inced:1;
-
- /*
- * Set if scst_cmd_init_stage1_done() called and the target wants
- * that the SN for the cmd won't be assigned until scst_restart_cmd()
- */
- unsigned int set_sn_on_restart_cmd:1;
-
- /* Set if the cmd's must not use sgv cache for data buffer */
- unsigned int no_sgv:1;
-
- /*
- * Set if target driver may need to call dma_sync_sg() or similar
- * function before transferring cmd' data to the target device
- * via DMA.
- */
- unsigned int may_need_dma_sync:1;
-
- /* Set if the cmd was done or aborted out of its SN */
- unsigned int out_of_sn:1;
-
- /* Set if increment expected_sn in cmd->scst_cmd_done() */
- unsigned int inc_expected_sn_on_done:1;
-
- /*
- * Set if xmit_response() is going to need a considerable processing
- * time. Processing time is considerable, if it's > context switch time
- * (about 1 usec on modern systems). It's needed to trigger other
- * threads to start processing other outstanding commands without
- * waiting XMIT for the current one to finish. E.g., it should be set
- * if iSCSI data digest used and cmd has READ direction.
- */
- unsigned int long_xmit:1;
-
- /* Set if tgt_sn field is valid */
- unsigned int tgt_sn_set:1;
-
- /* Set if cmd is done */
- unsigned int done:1;
-
- /* Set if cmd is finished */
- unsigned int finished:1;
-
- /**************************************************************/
-
- unsigned long cmd_flags; /* cmd's async flags */
-
- /* Keeps status of cmd's status/data delivery to remote initiator */
- int delivery_status;
-
- struct scst_tgt_template *tgtt; /* to save extra dereferences */
- struct scst_tgt *tgt; /* to save extra dereferences */
- struct scst_device *dev; /* to save extra dereferences */
-
- struct scst_tgt_dev *tgt_dev; /* corresponding device for this cmd */
-
- lun_t lun; /* LUN for this cmd */
-
- unsigned long start_time;
-
-#if LINUX_VERSION_CODE < KERNEL_VERSION(2,6,18)
- struct scsi_request *scsi_req; /* SCSI request */
-#endif
-
- /* List entry for tgt_dev's SN related lists */
- struct list_head sn_cmd_list_entry;
-
- /* Cmd's serial number, used to execute cmd's in order of arrival */
- unsigned long sn;
-
- /* The corresponding sn_slot in tgt_dev->sn_slots */
- atomic_t *sn_slot;
-
- /* List entry for session's search_cmd_list */
- struct list_head search_cmd_list_entry;
-
- /*
- * Used to found the cmd by scst_find_cmd_by_tag(). Set by the
- * target driver on the cmd's initialization time
- */
- uint64_t tag;
-
- uint32_t tgt_sn; /* SN set by target driver (for TM purposes) */
-
- /* CDB and its len */
- uint8_t cdb[SCST_MAX_CDB_SIZE];
- int cdb_len;
-
- enum scst_cdb_flags op_flags;
- const char *op_name;
-
- enum scst_cmd_queue_type queue_type;
-
- int timeout; /* CDB execution timeout */
- int retries; /* Amount of retries that will be done by SCSI mid-level */
-
- /* SCSI data direction, one of SCST_DATA_* constants */
- scst_data_direction data_direction;
-
- /* Remote initiator supplied values, if any */
- scst_data_direction expected_data_direction;
- int expected_transfer_len;
-
- /*
- * Cmd data length. Could be different from bufflen for commands like
- * VERIFY, which transfer different amount of data (if any), than
- * processed.
- */
- int data_len;
-
- /* Completition routine */
- void (*scst_cmd_done) (struct scst_cmd *cmd, int next_state);
-
- struct sgv_pool_obj *sgv; /* sgv object */
-
- int bufflen; /* cmd buffer length */
- struct scatterlist *sg; /* cmd data buffer SG vector */
- int sg_cnt; /* SG segments count */
-
- /* scst_get_sg_buf_[first,next]() support */
- int get_sg_buf_entry_num;
-
- /*
- * The following two fields should be corrected by the dev_done(),
- * if necessary
- */
- int tgt_resp_flags; /* response flags (SCST_TSC_FLAG_* constants) */
-
- /*
- * Response data length in data buffer. This field must not be set
- * directly, use scst_set_resp_data_len() for that
- */
- int resp_data_len;
-
- uint8_t status; /* status byte from target device */
- uint8_t msg_status; /* return status from host adapter itself */
- uint8_t host_status; /* set by low-level driver to indicate status */
- uint8_t driver_status; /* set by mid-level */
-
- uint8_t *sense; /* pointer to sense buffer */
-
- /* Used for storage of target driver private stuff */
- void *tgt_priv;
-
- /* Used for storage of dev handler private stuff */
- void *dh_priv;
-
- /*
- * Used to restore the SG vector if it was modified by
- * scst_set_resp_data_len()
- */
- int orig_sg_cnt, orig_sg_entry, orig_entry_len;
-
- /* List corresponding mgmt cmd, if any, protected by sess_list_lock */
- struct list_head mgmt_cmd_list;
-
- /* List entry for dev's blocked_cmd_list */
- struct list_head blocked_cmd_list_entry;
-
- struct scst_cmd *orig_cmd; /* Used to issue REQUEST SENSE */
-
-#ifdef MEASURE_LATENCY /* must be last */
- uint64_t start, pre_exec_finish, post_exec_start;
-#endif
-};
-
-struct scst_rx_mgmt_params
-{
- int fn;
- uint64_t tag;
- const uint8_t *lun;
- int lun_len;
- uint32_t cmd_sn;
- int atomic;
- void *tgt_priv;
- unsigned char tag_set;
- unsigned char lun_set;
- unsigned char cmd_sn_set;
-};
-
-struct scst_mgmt_cmd_stub
-{
- struct scst_mgmt_cmd *mcmd;
-
- /* List entry in cmd->mgmt_cmd_list */
- struct list_head cmd_mgmt_cmd_list_entry;
-};
-
-struct scst_mgmt_cmd
-{
- /* List entry for *_mgmt_cmd_list */
- struct list_head mgmt_cmd_list_entry;
-
- struct scst_session *sess;
-
- /* Mgmt cmd state, one of SCST_MGMT_CMD_STATE_* constants */
- int state;
-
- int fn;
-
- unsigned int completed:1; /* set, if the mcmd is completed */
- /* Set if device(s) should be unblocked after mcmd's finish */
- unsigned int needs_unblocking:1;
- unsigned int lun_set:1; /* set, if lun field is valid */
- unsigned int cmd_sn_set:1; /* set, if cmd_sn field is valid */
- unsigned int nexus_loss_check_done:1; /* set, if nexus loss check is done */
-
- /*
- * Number of commands to finish before sending response,
- * protected by scst_mcmd_lock
- */
- int cmd_finish_wait_count;
-
- /*
- * Number of commands to complete (done) before resetting reservation,
- * protected by scst_mcmd_lock
- */
- int cmd_done_wait_count;
-
- /* Number of completed commands, protected by scst_mcmd_lock */
- int completed_cmd_count;
-
- lun_t lun; /* LUN for this mgmt cmd */
- /* or (and for iSCSI) */
- uint64_t tag; /* tag of the corresponding cmd */
-
- uint32_t cmd_sn; /* affected command's highest SN */
-
- /* corresponding cmd (to be aborted, found by tag) */
- struct scst_cmd *cmd_to_abort;
-
- /* corresponding device for this mgmt cmd (found by lun) */
- struct scst_tgt_dev *mcmd_tgt_dev;
-
- /* completition status, one of the SCST_MGMT_STATUS_* constants */
- int status;
-
- /* Used for storage of target driver private stuff */
- void *tgt_priv;
-};
-
-struct scst_device
-{
- struct scst_dev_type *handler; /* corresponding dev handler */
-
- /* Pointer to lists of commands with the lock */
- struct scst_cmd_lists *p_cmd_lists;
-
- /* Lists of commands with lock, if dedicated threads are used */
- struct scst_cmd_lists cmd_lists;
-
- /* How many cmds alive on this dev */
- atomic_t dev_cmd_count;
-
- unsigned short type; /* SCSI type of the device */
-
- /*************************************************************
- ** Dev's flags. Updates serialized by dev_lock or suspended
- ** activity
- *************************************************************/
-
- /* Set if dev is RESERVED */
- unsigned short dev_reserved:1;
-
- /* Set if dev accepts only one command at time */
- unsigned short dev_serialized:1;
-
- /* Set if double reset UA is possible */
- unsigned short dev_double_ua_possible:1;
-
- /* Set if reset UA sent (to avoid double reset UAs) */
- unsigned short dev_reset_ua_sent:1;
-
- /**************************************************************/
-
- /*************************************************************
- ** Dev's control mode page related values. Updates serialized
- ** by scst_block_dev(). It's long to not interfere with the
- ** above flags.
- *************************************************************/
-
- unsigned long queue_alg:4;
- unsigned long tst:3;
- unsigned long tas:1;
- unsigned long swp:1;
-
- /*
- * Set if device implements own ordered commands management. If not set
- * and queue_alg is SCST_CONTR_MODE_QUEUE_ALG_RESTRICTED_REORDER,
- * expected_sn will be incremented only after commands finished.
- */
- unsigned long has_own_order_mgmt:1;
-
- /**************************************************************/
-
- spinlock_t dev_lock; /* device lock */
-
- /*
- * How many times device was blocked for new cmds execution.
- * Protected by dev_lock
- */
- int block_count;
-
- /*
- * How many there are "on_dev" commands, i.e. ones those are being
- * executed by the underlying SCSI/virtual device.
- */
- atomic_t on_dev_count;
-
- struct list_head blocked_cmd_list; /* protected by dev_lock */
-
- /* Used for storage of dev handler private stuff */
- void *dh_priv;
-
- /* Used to translate SCSI's cmd to SCST's cmd */
- struct gendisk *rq_disk;
-
- /* Corresponding real SCSI device, could be NULL for virtual devices */
- struct scsi_device *scsi_dev;
-
- /* Used to wait for requested amount of "on_dev" commands */
- wait_queue_head_t on_dev_waitQ;
-
- /* A list entry used during TM, protected by scst_mutex */
- struct list_head tm_dev_list_entry;
-
- /* Virtual device internal ID */
- int virt_id;
-
- /* Pointer to virtual device name, for convenience only */
- const char *virt_name;
-
- /* List entry in global devices list */
- struct list_head dev_list_entry;
-
- /*
- * List of tgt_dev's, one per session, protected by scst_mutex or
- * dev_lock for reads and both for writes
- */
- struct list_head dev_tgt_dev_list;
-
- /* List of acg_dev's, one per acg, protected by scst_mutex */
- struct list_head dev_acg_dev_list;
-
- /* List of dedicated threads, protected by scst_mutex */
- struct list_head threads_list;
-
- /* Device number */
- int dev_num;
-};
-
-/*
- * Used to store threads local tgt_dev specific data
- */
-struct scst_thr_data_hdr
-{
- /* List entry in tgt_dev->thr_data_list */
- struct list_head thr_data_list_entry;
- pid_t pid; /* PID of the owner thread */
- atomic_t ref;
- /* Function that will be called on the tgt_dev destruction */
- void (*free_fn) (struct scst_thr_data_hdr *data);
-};
-
-/*
- * Used to store per-session specific device information
- */
-struct scst_tgt_dev
-{
- /* List entry in sess->sess_tgt_dev_list_hash */
- struct list_head sess_tgt_dev_list_entry;
-
- struct scst_device *dev; /* to save extra dereferences */
- lun_t lun; /* to save extra dereferences */
-
- /* How many cmds alive on this dev in this session */
- atomic_t tgt_dev_cmd_count;
-
- int gfp_mask;
- struct sgv_pool *pool;
- int max_sg_cnt;
-
- unsigned long tgt_dev_flags; /* tgt_dev's async flags */
-
- /*
- * Used to execute cmd's in order of arrival, honoring SCSI task
- * attributes.
- *
- * Protected by sn_lock, except expected_sn, which is protected by
- * itself. Curr_sn must have the same size as expected_sn to
- * overflow simultaneously.
- */
- int def_cmd_count;
- spinlock_t sn_lock;
- unsigned long expected_sn;
- unsigned long curr_sn;
- int hq_cmd_count;
- struct list_head deferred_cmd_list;
- struct list_head skipped_sn_list;
-
- /*
- * Set if the prev cmd was ORDERED. Size must allow unprotected
- * modifications
- */
- unsigned long prev_cmd_ordered;
-
- int num_free_sn_slots; /* if it's <0, then all slots are busy */
- atomic_t *cur_sn_slot;
- atomic_t sn_slots[15];
-
- /* Used for storage of dev handler private stuff */
- void *dh_priv;
-
- /* List of scst_thr_data_hdr and lock */
- spinlock_t thr_data_lock;
- struct list_head thr_data_list;
-
- spinlock_t tgt_dev_lock; /* per-session device lock */
-
- /* List of UA's for this device, protected by tgt_dev_lock */
- struct list_head UA_list;
-
- struct scst_session *sess; /* corresponding session */
- struct scst_acg_dev *acg_dev; /* corresponding acg_dev */
-
- /* list entry in dev->dev_tgt_dev_list */
- struct list_head dev_tgt_dev_list_entry;
-
- /* internal tmp list entry */
- struct list_head extra_tgt_dev_list_entry;
-};
-
-/*
- * Used to store ACG-specific device information, like LUN
- */
-struct scst_acg_dev
-{
- struct scst_device *dev; /* corresponding device */
- lun_t lun; /* device's LUN in this acg */
- unsigned int rd_only_flag:1; /* if != 0, then read only */
- struct scst_acg *acg; /* parent acg */
-
- /* list entry in dev->dev_acg_dev_list */
- struct list_head dev_acg_dev_list_entry;
-
- /* list entry in acg->acg_dev_list */
- struct list_head acg_dev_list_entry;
-};
-
-/*
- * ACG - access control group. Used to store group related
- * control information.
- */
-struct scst_acg
-{
- /* List of acg_dev's in this acg, protected by scst_mutex */
- struct list_head acg_dev_list;
-
- /* List of attached sessions, protected by scst_mutex */
- struct list_head acg_sess_list;
-
- /* List of attached acn's, protected by scst_mutex */
- struct list_head acn_list;
-
- /* List entry in scst_acg_list */
- struct list_head scst_acg_list_entry;
-
- /* Name of this acg */
- const char *acg_name;
-
- /* The pointer to the /proc directory entry */
- struct proc_dir_entry *acg_proc_root;
-};
-
-/*
- * ACN - access control name. Used to store names, by which
- * incoming sessions will be assigned to appropriate ACG.
- */
-struct scst_acn
-{
- /* Initiator's name */
- const char *name;
- /* List entry in acg->acn_list */
- struct list_head acn_list_entry;
-};
-
-/*
- * Used to store per-session UNIT ATTENTIONs
- */
-struct scst_tgt_dev_UA
-{
- /* List entry in tgt_dev->UA_list */
- struct list_head UA_list_entry;
- /* Unit Attention sense */
- uint8_t UA_sense_buffer[SCST_SENSE_BUFFERSIZE];
-};
-
-#ifndef smp_mb__after_set_bit
-/* There is no smp_mb__after_set_bit() in the kernel */
-#define smp_mb__after_set_bit() smp_mb();
-#endif
-
-/*
- * Registers target template
- * Returns 0 on success or appropriate error code otherwise
- */
-int __scst_register_target_template(struct scst_tgt_template *vtt,
- const char *version);
-static inline int scst_register_target_template(struct scst_tgt_template *vtt)
-{
- return __scst_register_target_template(vtt, SCST_INTERFACE_VERSION);
-}
-
-/*
- * Unregisters target template
- */
-void scst_unregister_target_template(struct scst_tgt_template *vtt);
-
-/*
- * Registers and returns target adapter
- * Returns new target structure on success or NULL otherwise.
- *
- * If parameter "target_name" isn't NULL, then security group with name
- * "Default_##target_name", if created, will be used as the default
- * instead of "Default" one for all initiators not assigned to any other group.
- */
-struct scst_tgt *scst_register(struct scst_tgt_template *vtt,
- const char *target_name);
-
-/*
- * Unregisters target adapter
- */
-void scst_unregister(struct scst_tgt *tgt);
-
-/*
- * Registers and returns a session
- *
- * Returns new session on success or NULL otherwise
- *
- * Parameters:
- * tgt - target
- * atomic - true, if the function called in the atomic context
- * initiator_name - remote initiator's name, any NULL-terminated string,
- * e.g. iSCSI name, which used as the key to found appropriate access
- * control group. Could be NULL, then "default" group is used.
- * The groups are set up via /proc interface.
- * data - any target driver supplied data
- * result_fn - pointer to the function that will be
- * asynchronously called when session initialization finishes.
- * Can be NULL. Parameters:
- * - sess - session
- * - data - target driver supplied to scst_register_session() data
- * - result - session initialization result, 0 on success or
- * appropriate error code otherwise
- *
- * Note: A session creation and initialization is a complex task,
- * which requires sleeping state, so it can't be fully done
- * in interrupt context. Therefore the "bottom half" of it, if
- * scst_register_session() is called from atomic context, will be
- * done in SCST thread context. In this case scst_register_session()
- * will return not completely initialized session, but the target
- * driver can supply commands to this session via scst_rx_cmd().
- * Those commands processing will be delayed inside SCST until
- * the session initialization is finished, then their processing
- * will be restarted. The target driver will be notified about
- * finish of the session initialization by function result_fn().
- * On success the target driver could do nothing, but if the
- * initialization fails, the target driver must ensure that
- * no more new commands being sent or will be sent to SCST after
- * result_fn() returns. All already sent to SCST commands for
- * failed session will be returned in xmit_response() with BUSY status.
- * In case of failure the driver shall call scst_unregister_session()
- * inside result_fn(), it will NOT be called automatically.
- */
-struct scst_session *scst_register_session(struct scst_tgt *tgt, int atomic,
- const char *initiator_name, void *data,
- void (*result_fn) (struct scst_session *sess, void *data, int result));
-
-/*
- * Unregisters a session.
- * Parameters:
- * sess - session to be unregistered
- * wait - if true, instructs to wait until all commands, which
- * currently is being executed and belonged to the session, finished.
- * Otherwise, target driver should be prepared to receive
- * xmit_response() for the session's command after
- * scst_unregister_session() returns.
- * unreg_done_fn - pointer to the function that will be
- * asynchronously called when the last session's command finishes and
- * the session is about to be completely freed. Can be NULL.
- * Parameter:
- * - sess - session
- * unreg_cmds_done_fn - pointer to the function that will be
- * asynchronously called when the last session's command completes, i.e.
- * goes to XMIT stage. Can be NULL.
- * Parameter:
- * - sess - session
- *
- * Notes:
- *
- * - All outstanding commands will be finished regularly. After
- * scst_unregister_session() returned no new commands must be sent to
- * SCST via scst_rx_cmd().
- *
- * - The caller must ensure that no scst_rx_cmd() or scst_rx_mgmt_fn_*() is
- * called in paralell with scst_unregister_session().
- *
- * - Can be called before result_fn() of scst_register_session() called,
- * i.e. during the session registration/initialization.
- *
- * - It is highly recommended to call scst_unregister_session() as soon as it
- * gets clear that session will be unregistered and not to wait until all
- * related commands finished. This function provides the wait functionality,
- * but it also starts recovering stuck commands, if there are any.
- * Otherwise, your target driver could wait for those commands forever.
- */
-void scst_unregister_session_ex(struct scst_session *sess, int wait,
- void (*unreg_done_fn) (struct scst_session *sess),
- void (*unreg_cmds_done_fn) (struct scst_session *sess));
-
-static inline void scst_unregister_session(struct scst_session *sess, int wait,
- void (*unreg_done_fn) (struct scst_session *sess))
-{
- scst_unregister_session_ex(sess, wait, unreg_done_fn, NULL);
-}
-
-/*
- * Registers dev handler driver
- * Returns 0 on success or appropriate error code otherwise
- */
-int __scst_register_dev_driver(struct scst_dev_type *dev_type,
- const char *version);
-static inline int scst_register_dev_driver(struct scst_dev_type *dev_type)
-{
- return __scst_register_dev_driver(dev_type, SCST_INTERFACE_VERSION);
-}
-
-/*
- * Unregisters dev handler driver
- */
-void scst_unregister_dev_driver(struct scst_dev_type *dev_type);
-
-/*
- * Registers dev handler driver for virtual devices (eg VDISK)
- * Returns 0 on success or appropriate error code oth...
[truncated message content] |
