diff options
Diffstat (limited to 'src')
| -rw-r--r-- | src/server/image.c | 2 | ||||
| -rw-r--r-- | src/server/iscsi.c | 11331 | ||||
| -rw-r--r-- | src/server/iscsi.h | 9303 | ||||
| -rw-r--r-- | src/server/net.c | 67 | ||||
| -rw-r--r-- | src/server/sendfile.c | 60 | ||||
| -rw-r--r-- | src/server/sendfile.h | 18 | ||||
| -rw-r--r-- | src/server/server.c | 10 | ||||
| -rw-r--r-- | src/server/uplink.c | 4 | ||||
| -rw-r--r-- | src/server/uplink.h | 2 |
9 files changed, 2732 insertions, 18065 deletions
diff --git a/src/server/image.c b/src/server/image.c index a2ff247..5d1f4a1 100644 --- a/src/server/image.c +++ b/src/server/image.c @@ -1361,7 +1361,7 @@ server_fail: ; image_release( image ); } // If everything worked out, this call should now actually return the image - image = image_get( name, acceptedRemoteRid, false ); + image = image_get( name, revision == 0 ? acceptedRemoteRid : revision, false ); if ( image != NULL && uplinkSock != -1 ) { // If so, init the uplink and pass it the socket if ( !uplink_init( image, uplinkSock, &uplinkServer, remoteProtocolVersion ) ) { diff --git a/src/server/iscsi.c b/src/server/iscsi.c index e9b0fc1..2b39955 100644 --- a/src/server/iscsi.c +++ b/src/server/iscsi.c @@ -20,7 +20,6 @@ #include <ctype.h> #include <errno.h> -#include <fnmatch.h> #include <stdarg.h> #include <stdbool.h> #include <stddef.h> @@ -36,20 +35,22 @@ #include <dnbd3/shared/sockhelper.h> #include <dnbd3/types.h> #include <pthread.h> -#include <time.h> #include <unistd.h> -#include "fileutil.h" #include "globals.h" #include "helper.h" #include "image.h" -#include "ini.h" #include "iscsi.h" -#include "locks.h" #include "uplink.h" -#include "threadpool.h" #include "reference.h" +#include <assert.h> + +#define ISCSI_DEFAULT_LUN 1 +#define ISCSI_DEFAULT_PROTOCOL_ID 1 +#define ISCSI_DEFAULT_DEVICE_ID 1 +#define ISCSI_DEFAULT_QUEUE_DEPTH 16 + /** * @file iscsi.c * @author Sebastian Vater @@ -63,102 +64,56 @@ * @see https://www.rfc-editor.org/rfc/rfc7143 */ +//#define malloc(x) (rand() % 100 == 0 ? NULL : malloc(x)) -/** - * @brief Allocates and appends a buffer and sprintf's it. - * - * Merges multiple strings using printf style formatting - * and allocates memory for holding the result. - * - * @param[in] buf Buffer to merge into. - * @param[in] format printf style format string. - * @param[in] args Values to fill in the format with. - * @return New buffer which holds the final result. - */ -uint8_t *iscsi_vsprintf_append_realloc(char *buf, const char *format, va_list args) -{ - va_list args_copy; - uint orig_size = 0U; - if ( buf != NULL ) - orig_size = (uint) strlen( (char *) buf ); +static int iscsi_scsi_emu_block_process(iscsi_scsi_task *scsi_task); - va_copy( args_copy, args ); - uint new_size = vsnprintf( NULL, 0, format, args_copy ); - va_end( args_copy ); +static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task); - new_size += (uint) (orig_size + 1U); - uint8_t *new_buf = realloc( buf, new_size ); +static void iscsi_scsi_task_create(iscsi_scsi_task *scsi_task); // Allocates and initializes a SCSI task - if ( new_buf == NULL ) { - logadd( LOG_ERROR, "iscsi_vsprintf_append_realloc: Out of memory while allocating string buffer" ); +static void iscsi_scsi_task_xfer_complete(iscsi_scsi_task *scsi_task, iscsi_pdu *pdu); // Callback function when an iSCSI SCSI task completed the data transfer - return NULL; - } +static void iscsi_scsi_task_lun_process_none(iscsi_scsi_task *scsi_task); // Processes a iSCSI SCSI task with no LUN identifier - vsnprintf( (char *) (new_buf + orig_size), (new_size - orig_size), format, args ); - return new_buf; -} +static uint64_t iscsi_scsi_lun_get_from_scsi(const int lun_id); // Converts an internal representation of a LUN identifier to an iSCSI LUN required for packet data +static int iscsi_scsi_lun_get_from_iscsi(const uint64_t lun); // Converts an iSCSI LUN from packet data to internal SCSI LUN identifier -/** - * @brief Allocates and appends a buffer and sprintf's it. - * - * Merges strings using printf style formatting and allocates - * memory for holding the result. - * - * @param[in] buf Buffer to merge into. - * @param[in] format printf style format string. - * @param[in] ... Values to fill in the format string with. - * @return New buffer which holds the final result. - */ -uint8_t *iscsi_sprintf_append_realloc(char *buf, const char *format, ...) -{ - va_list args; +static void iscsi_scsi_lun_task_run( iscsi_scsi_task *scsi_task, iscsi_pdu *pdu); // Runs an iSCSI SCSI task for a specified iSCSI SCSI LUN - va_start( args, format ); - uint8_t *ret_buf = iscsi_vsprintf_append_realloc( buf, format, args ); - va_end( args ); +static int iscsi_scsi_emu_io_blocks_read(iscsi_scsi_task *scsi_task, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks); // Reads a number of blocks from a block offset of a DNBD3 image to a specified buffer - return ret_buf; -} -/** - * @brief Allocates a buffer and sprintf's it. - * - * Merges strings using printf style formatting and allocates - * memory for holding the result. - * - * @param[in] format printf style format string. - * @param[in] args Values to fill in the format with. - * @return New buffer which holds the final result. - */ -uint8_t *iscsi_vsprintf_alloc(const char *format, va_list args) -{ - return iscsi_vsprintf_append_realloc( NULL, format, args ); -} +static void iscsi_strcpy_pad(char *dst, const char *src, const size_t size, const int pad); // Copies a string with additional padding character to fill in a specified size -/** - * @brief Allocates a buffer and sprintf's it. - * - * Allocates a buffer large enough to hold printf style - * string concatenation and fills it using vspnrintf. - * - * @param[in] format Format string to allocate and fill. - * @param[in] ... Values to fill in the format string with. - * @return New buffer containing the formatted string. - */ -uint8_t *iscsi_sprintf_alloc(const char *format, ... ) -{ - va_list args; - va_start( args, format ); - uint8_t *buf = iscsi_vsprintf_alloc( format, args ); - va_end( args ); +static iscsi_task *iscsi_task_create(iscsi_connection *conn); // Allocates and initializes an iSCSI task structure +static void iscsi_task_destroy(iscsi_task *task); // Deallocates resources acquired by iscsi_task_create + +static void iscsi_task_response(iscsi_connection *conn, iscsi_task *task, iscsi_pdu *pdu); // Creates, initializes and sends an iSCSI task reponse PDU. + +static uint64_t iscsi_target_node_wwn_get(const uint8_t *name); // Calculates the WWN using 64-bit IEEE Extended NAA for a name + +static iscsi_session *iscsi_session_create(iscsi_connection *conn, const int type); // Creates and initializes an iSCSI session +static void iscsi_session_destroy(iscsi_session *session); // Deallocates all resources acquired by iscsi_session_create + + +static iscsi_connection *iscsi_connection_create(dnbd3_client_t *client); // Creates data structure for an iSCSI connection from iSCSI portal and TCP/IP socket +static void iscsi_connection_destroy(iscsi_connection *conn); // Deallocates all resources acquired by iscsi_connection_create + +static int32_t iscsi_connection_read(const iscsi_connection *conn, uint8_t *buf, const uint32_t len); // Reads data for the specified iSCSI connection from its TCP socket + +static void iscsi_connection_login_response_reject(iscsi_pdu *login_response_pdu, const iscsi_pdu *pdu); // Initializes a rejecting login response packet +static iscsi_pdu *iscsi_connection_pdu_create(iscsi_connection *conn, const uint32_t ds_len); +static void iscsi_connection_pdu_destroy(iscsi_pdu *pdu); // Destroys an iSCSI PDU structure used by connections + +static iscsi_bhs_packet *iscsi_connection_pdu_resize(iscsi_pdu *pdu, const uint ahs_len, const uint32_t ds_len); // Appends packet data to an iSCSI PDU structure used by connections + +static bool iscsi_connection_pdu_write(iscsi_connection *conn, iscsi_pdu *pdu); - return buf; -} /** * @brief Copies a string with additional padding character to fill in a specified size. @@ -175,7 +130,7 @@ uint8_t *iscsi_sprintf_alloc(const char *format, ... ) * @param[in] size Total size in bytes for padding. * @param[in] pad Padding character to use. */ -void iscsi_strcpy_pad(char *dst, const char *src, const size_t size, const int pad) +static void iscsi_strcpy_pad(char *dst, const char *src, const size_t size, const int pad) { const size_t len = strlen( src ); @@ -187,2172 +142,46 @@ void iscsi_strcpy_pad(char *dst, const char *src, const size_t size, const int p } } -/** - * @brief Creates an empty hash map with either specified or default capacity. - * - * Creates a ultra hardcore speed optimized empty - * hash map and allocates enough buckets to hold - * default capacity elements.\n - * The speed optimizations require all keys - * having a size of a multiple of 8 bytes with - * zero padding. Also the capacity always nas - * to be a power of two.\n - * TODO: Move all hash map related functions to - * different source file later and implement in - * a lock-free way for better concurrency. - * - * @param[in] capacity Desired initial capacity, will be rounded up - * to the nearest power of two. If set to 0, a - * default capacity of 32 buckets will be used - * instead. - * @return A pointer to the hash map structure or NULL in case of an error. - */ -iscsi_hashmap *iscsi_hashmap_create(const uint capacity) -{ - iscsi_hashmap *map = (iscsi_hashmap *) malloc( sizeof(iscsi_hashmap) ); - - if ( map == NULL ) { - logadd( LOG_ERROR, "iscsi_hashmap_create: Out of memory while allocating iSCSI hash map" ); - - return map; - } - - if ( capacity > 0U ) { - uint new_capacity = (uint) iscsi_align_pow2_ceil( (uint32_t) capacity ); - - if ( (capacity + 1U) > (uint) ((new_capacity * 3U) >> 2U) ) - new_capacity += new_capacity; // If specified capacity does not fit in 75% of requested capacity, double actual size - - map->capacity = new_capacity; // Round up actual new capacity to nearest power of two - } else { - map->capacity = ISCSI_HASHMAP_DEFAULT_CAPACITY; - } - - map->buckets = (iscsi_hashmap_bucket *) calloc( map->capacity, sizeof(struct iscsi_hashmap_bucket) ); - - if ( map->buckets == NULL ) { - free( map ); - - logadd( LOG_ERROR, "iscsi_hashmap_create: Out of memory while allocating iSCSI hash map buckets" ); - - return NULL; - } - - iscsi_list_create( &map->list ); - - map->last_insert_id = 0ULL; - map->cap_load = (uint) ((map->capacity * 3U) >> 2U); // 75% of capacity - map->count = 0U; - - return map; -} - -/** - * @brief Deallocates the hash map objects and buckets, not elements. Use iscsi_hashmap_iterate to deallocate the elements themselves. - * - * Deallocates all buckets and the hash map itself - * allocated by iscsi_hashmap_create. The elements - * associated with the buckets are NOT freed by this - * function, this has to be done either manually or - * using the function iscsi_hashmap_iterate. - * - * @param[in] map Pointer to hash map and its buckets to deallocate. - * If this is NULL, nothing is done. - */ -void iscsi_hashmap_destroy(iscsi_hashmap *map) -{ - if ( map != NULL ) { - if ( map->buckets != NULL ) { - free( map->buckets ); - - map->buckets = NULL; - } - - free( map ); - } -} - -/** - * @brief Creates a key suitable for hash map usage (ensures 8-byte boundary and zero padding). - * - * Creates a key from data and size and ensures - * its requirements for usage in hash map buckets.\n - * Currently keys to be used in a hash map bucket - * require a size of multiple by 8 bytes with - * the zero padding. - * - * @param[in] data Pointer to data to construct the key - * from and may NOT be NULL, so be careful. - * @param[in] len Length of the data to construct the key - * from, MUST be larger than 0, so be careful. - * @return Pointer to generated usable key or NULL in - * case of an error (usually memory exhaustion). - */ -uint8_t *iscsi_hashmap_key_create(const uint8_t *data, const size_t len) -{ - const size_t key_size = ISCSI_ALIGN(len, ISCSI_HASHMAP_KEY_ALIGN); - uint8_t *key = (uint8_t *) malloc( key_size ); - - if ( key == NULL ) { - logadd( LOG_ERROR, "iscsi_hashmap_key_create: Out of memory while allocating iSCSI hash map key" ); - - return key; - } - - memcpy( key, data, len ); - memset( (key + len), 0, (key_size - len) ); // Zero pad additional bytes in case length is not a multiple of 8 - - return key; -} - -/** - * @brief Creates an unique key identifier suitable for hash map usage (ensures 8-byte boundary and zero padding). - * - * Creates a unique key identifier by adding - * the capacity and element count plus one - * together as an unsigned 64-bit integer - * and uses the resulting value as key data - * which ensure the requirements for usage - * in hash map buckets.\n - * This function returns the same identifier if - * the previously generated key identifier has - * NOT been added to the hash map yet.\n - * Currently keys to be used in a hash map bucket - * require a size of multiple by 8 bytes with - * the zero padding. - * - * @param[in] map Pointer to hash map to construct the key - * for and may NOT be NULL, so be careful. - * @param[out] key Pointer to key to store the - * unique key in. NULL is NOT allowed here, be - * careful. - */ -void iscsi_hashmap_key_create_id(iscsi_hashmap *map, uint64_t *key) -{ - *key = ++map->last_insert_id; -} - -/** - * @brief Deallocates all resources acquired by iscsi_hashmap_create_key. - * - * Deallocates a key allocated with the function - * iscsi_hashmap_key_create. - * - * @param[in] key Pointer to key to deallocate, may NOT - * be NULL, so be careful. - */ -void iscsi_hashmap_key_destroy(uint8_t *key) -{ - free( key ); -} - -/** - * @brief Deallocates a key in a hash map. - * - * Default callback function for deallocation of - * hash map resources by simply deallocating - * the key. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, not used here. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_hashmap_key_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** - * @brief Deallocates a value in a hash map. - * - * Default callback function for deallocation of - * hash map resources by simply deallocating - * the value. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_hashmap_destroy_value_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - if ( value != NULL ) - free( value ); - - return 0; -} - -/** - * @brief Deallocates a key / value pair in a hash map by calling free (default destructor). - * - * Default callback function for deallocation of - * allocated hash map resources by simply calling - * free. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key, - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_hashmap_key_destroy_value_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - if ( value != NULL ) - free( value ); - - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** - * @brief Compares two hash keys with equal length match. - * - * This function is optimized to compare - * 8 bytes at once and requires number - * of blocks specified in QWORDs. Both - * keys must be equal in size of a - * QWORD alignment. - * - * @param[in] buf Pointer to key buffer of which key - * to compare. May NOT be NULL, so be - * careful. - * @param[in] key Pointer to key to compare with. - * NULL is NOT allowed here, take - * caution. - * @param[in] num_blocks Number of blocks in QWORDs (8 bytes) - * to be compared. - */ -static inline bool iscsi_hashmap_key_eq(const uint64_t *buf, const uint64_t *key, size_t num_blocks) -{ - do { - if ( *buf++ != *key++ ) - return false; - } while ( --num_blocks > 0UL ); - - return true; -} - -/** - * @brief Finds a bucket by key of a specified hash map by key, key size and hash code. - * - * Finds a bucket by key of a specified hash map by - * key, key size and hash code. This function may - * only be called if the bucket is guaranteed to - * be found, otherwise this function hangs, so be - * careful. - * - * @param[in] map Pointer to hash map where the key to be - * searched for is located, may NOT be NULL, so be careful. - * @param[in] key Pointer to key. NULL is invalid, so be - * careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] hash Hash of the key to be searched for. - * @return Pointer to found bucket. - */ -static iscsi_hashmap_bucket *iscsi_hashmap_find_entry(iscsi_hashmap *map, const uint8_t *key, size_t key_size, uint32_t hash) -{ - const size_t num_blocks = ISCSI_ALIGN(key_size, ISCSI_HASHMAP_KEY_ALIGN) >> ISCSI_HASHMAP_KEY_ALIGN_SHIFT; - uint32_t index = (hash & (map->capacity - 1U)); - - for ( ;; ) { - iscsi_hashmap_bucket *entry = &map->buckets[index]; - - if ( ((entry->key == NULL) && (entry->value == NULL)) || ((entry->key != NULL) && (entry->key_size == key_size) && (entry->hash == hash) && iscsi_hashmap_key_eq( (uint64_t *) entry->key, (uint64_t *) key, num_blocks )) ) - return entry; - - index = ((index + 1UL) & (map->capacity - 1U)); - } -} - -/** - * @brief Calculates the hash code of data with a specified length. - * - * Calculates the hash code of data with a specified - * length. - * - * @param[in] data Pointer to data to be hashed, NULL is NOT - * an allowed here, so be careful. Data needs 8 byte alignment - * and needs to be zero padded. - * @param[in] len Number of bytes of hash data, must be larger - * than 0 and is rounded up to the nearest 8 byte integer prior - * calculating the hash code, so be careful. - * @return Hash code of data. - */ -static inline uint32_t iscsi_hashmap_key_hash_data(const uint8_t *data, const size_t len) -{ - const uint64_t *hash_data = (const uint64_t *) data; - size_t num_blocks = ISCSI_ALIGN(len, ISCSI_HASHMAP_KEY_ALIGN) >> ISCSI_HASHMAP_KEY_ALIGN_SHIFT; - uint64_t hash = ISCSI_HASHMAP_HASH_INITIAL; - - do { - hash ^= *hash_data++; - hash *= ISCSI_HASHMAP_HASH_MUL; - } while ( --num_blocks > 0UL ); - - return (uint32_t) (hash ^ hash >> 32ULL); -} - -/** - * @brief Puts an old bucket into a resized hash map. - * - * Puts an old bucket into a resized hash map. - * - * @param[in] map Pointer to resized hash map, may NOT be NULL, so - * be careful. - * @param[in] old_entry The old bucket to be put into the resized - * hash map. - * @return New bucket where the bucket has been put into. - */ -static iscsi_hashmap_bucket *iscsi_hashmap_resize_entry(iscsi_hashmap *map, const iscsi_hashmap_bucket *old_entry) -{ - uint32_t index = (old_entry->hash & (map->capacity - 1U)); - - for ( ;; ) { - iscsi_hashmap_bucket *entry = &map->buckets[index]; - - if ( entry->key == NULL ) { - entry->key = old_entry->key; - entry->key_size = old_entry->key_size; - entry->hash = old_entry->hash; - entry->value = old_entry->value; - - return entry; - } - - index = ((index + 1) & (map->capacity - 1U)); - } -} - -/** - * @brief Resizes a hash map by doubling its bucket capacity. - * - * Resizes a hash map by doubling its bucket capacity The - * old bucket list is freed after the - * resize operation has been finished. - * - * @param[in] map Pointer to hash map to resize. This may NOT be - * NULL, so be careful. - * @retval -1 An error occured during resize. - * @retval 0 Hash map has been resized successfully. - */ -static int iscsi_hashmap_resize(iscsi_hashmap *map) -{ - const uint old_capacity = map->capacity; - iscsi_hashmap_bucket *old_buckets = map->buckets; - iscsi_list old_list = {map->list.head, map->list.tail, map->list.pred}; - - map->capacity <<= ISCSI_HASHMAP_RESIZE_SHIFT; - - map->buckets = (iscsi_hashmap_bucket *) calloc( map->capacity, sizeof(struct iscsi_hashmap_bucket) ); - - if ( map->buckets == NULL ) { - map->capacity = old_capacity; - map->buckets = old_buckets; - - return -1; - } - - map->cap_load = (uint) ((map->capacity * 3U) >> 2U); // 75% of capacity - - iscsi_list_clear( &map->list ); - - iscsi_hashmap_bucket *current; - iscsi_hashmap_bucket *tmp; - - iscsi_list_foreach_safe_node ( &old_list, current, tmp ) { - if ( current->key == NULL ) - continue; - - current = iscsi_hashmap_resize_entry( map, current ); - - iscsi_list_enqueue( &map->list, ¤t->node ); - } - - free( old_buckets ); - - return 0; -} - -/** - * @brief Assigns key / value pair to hash map at the tail of doubly linked list without making copies. - * - * Adds a key / value pair to a specified hash map - * bucket list, if it doesn't exist already. The - * buckets are resized automatically if required.\n - * This function neither does make a copy of the key, - * nor of the value. Keys should be allocated using - * the function iscsi_hashmap_key_create or freed by - * using iscsi_hashmap_key_destroy in order to - * ensure the alignment and padding requirements.\n - * The new pair will always added to the tail of the - * linked list. - * - * @param[in] map Pointer to hash map where the key and - * value pair should be added to, may NOT be NULL, so - * be careful. - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key to add, NULL is - * allowed. - * @retval -1 Adding key / value pair would have required - * hash map resizing which failed (probably due to - * memory exhaustion). - * @retval 0 Key / value pair was added successfully. - */ -int iscsi_hashmap_put(iscsi_hashmap *map, uint8_t *key, const size_t key_size, uint8_t *value) -{ - if ( ((map->count + 1U) > map->cap_load) && (iscsi_hashmap_resize( map ) < 0) ) - return -1; - - const uint32_t hash = iscsi_hashmap_key_hash_data( key, key_size ); - iscsi_hashmap_bucket *entry = iscsi_hashmap_find_entry( map, key, key_size, hash ); - - if ( entry->key == NULL ) { - iscsi_list_enqueue( &map->list, &entry->node ); - - map->count++; - - entry->key = key; - entry->key_size = key_size; - entry->hash = hash; - } - - entry->value = value; - - return 0; -} - -/** - * @brief Assigns key / value pair to hash map at the tail of doubly linked list without making copies. - * - * Adds a key / value pair if it doesn't exist - * using the value of `*out_in_val`. If the pair - * does exist, value will be set in `*out_in`, - * meaning the value of the pair will be in - * '*out_in` regardless of whether or not it it - * existed in the first place.\n - * The buckets are resized automatically if required. - * This function neither does make a copy of the key, - * nor of the value. Keys should be allocated using - * the function iscsi_hashmap_key_create or freed by - * using iscsi_hashmap_key_destroy in order to - * ensure the alignment and padding requirements. - * - * @param[in] map Pointer to hash map where the key and - * value pair should be added to, may NOT be NULL, so - * be careful. - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in,out] out_in_value Value of the key to add, - * NULL is allowed. - * @retval -1 Adding key / value pair would have required - * hash map resizing which failed (probably due to - * memory exhaustion). - * @retval 0 Key / value pair was added successfully. - * @retval 1 Key already existed. - */ -int iscsi_hashmap_get_put(iscsi_hashmap *map, uint8_t *key, const size_t key_size, uint8_t **out_in_value) -{ - if ( ((map->count + 1U) > map->cap_load) && (iscsi_hashmap_resize( map ) < 0) ) - return -1; - - const uint32_t hash = iscsi_hashmap_key_hash_data( key, key_size ); - iscsi_hashmap_bucket *entry = iscsi_hashmap_find_entry( map, key, key_size, hash ); - - if ( entry->key == NULL ) { - iscsi_list_enqueue( &map->list, &entry->node ); - - entry->key = key; - entry->key_size = key_size; - entry->hash = hash; - entry->value = *out_in_value; - - map->count++; - - return 0; - } - - *out_in_value = entry->value; - - return 1; -} - -/** - * @brief Assigns key / value pair to hash map without making copies with callback function in case the key already exists. - * - * Adds a key / value pair to a specified hash map - * bucket list. If the key already exists, it will - * be overwritten and a callback function will be - * invoked in order to allow, e.g. deallocation of - * resources, if necessary. The buckets are resized - * automatically if required. This function neither - * does make a copy of the key, nor of the value.\n - * Keys should be allocated using the function - * iscsi_hashmap_key_create or freed by using - * iscsi_hashmap_key_destroy in order to ensure the - * alignment and padding requirements. - * - * @param[in] map Pointer to hash map where the key and - * value pair should be added to, may NOT be NULL, so - * be careful. - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key to add, NULL is - * allowed. - * @param[in] callback Callback function which allows, - * for example, a dallocation of resources for the - * overwritten key and value pair. The function is - * invoked just before overwriting the old values. - * This may NOT be NULL, so take caution. - * @param[in,out] user_data Pointer to user specific data - * passed to the callback function in case more - * information is needed. - * @return -1 in case adding key / value pair would - * have required hash map resizing which failed - * (probably due to memory exhaustion), 0 if the - * Key / value pair was added successfully and - * the callback function also returned 0, otherwise - * the return value got by the callbuck function. - */ -int iscsi_hashmap_put_free(iscsi_hashmap *map, uint8_t *key, const size_t key_size, uint8_t *value, iscsi_hashmap_callback callback, uint8_t *user_data) -{ - if ( ((map->count + 1U) > map->cap_load) && (iscsi_hashmap_resize( map ) < 0) ) - return -1; - - const uint32_t hash = iscsi_hashmap_key_hash_data( key, key_size ); - iscsi_hashmap_bucket *entry = iscsi_hashmap_find_entry( map, key, key_size, hash ); - - if ( entry->key == NULL ) { - iscsi_list_enqueue( &map->list, &entry->node ); - - entry->key = key; - entry->key_size = key_size; - entry->hash = hash; - entry->value = value; - - map->count++; - - return 0; - } - - int err = callback( entry->key, key_size, entry->value, user_data ); - - entry->key = key; - entry->value = value; - - return err; -} - -/** - * @brief Checks whether a specified key exists. - * - * Checks whether a specified key exists in a hash map. - * - * @param[in] map Pointer to the hash map to be searched - * for the key to check for existence and may NOT be - * NULL, so take caution. - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @retval true The key exists. - * @retval false The key does not exist. - */ -bool iscsi_hashmap_contains(iscsi_hashmap *map, const uint8_t *key, const size_t key_size) -{ - const uint32_t hash = iscsi_hashmap_key_hash_data( key, key_size ); - iscsi_hashmap_bucket *entry = iscsi_hashmap_find_entry( map, key, key_size, hash ); - - return (entry->key != NULL); -} - -/** - * @brief Retrieves the value of a specified key. - * - * Retrieves the value of a specified key from a hash - * map. Since the hash map supports NULL values, it - * is stored in an output variable. - * - * @param[in] map Pointer to the hash map to be searched - * for the key of which the value should be - * retrieved and may NOT be NULL, so take - * caution. - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[out] out_value Pointer where the value of the found key - * is stored, maybe NULL if either the key's value - * is NULL or in case the key was not found. The - * pointer to the value itself may NOT be NULL, - * so be careful. - * @retval 0 The key has been found and its value stored - * in the 'out_value' parameter. - * @retval -1 The key has not been found and NULL has been - * stored in the 'out_value' parameter. - */ -int iscsi_hashmap_get(iscsi_hashmap *map, const uint8_t *key, const size_t key_size, uint8_t **out_value) -{ - const uint32_t hash = iscsi_hashmap_key_hash_data( key, key_size ); - iscsi_hashmap_bucket *entry = iscsi_hashmap_find_entry( map, key, key_size, hash ); - - *out_value = entry->value; - - return ((entry->key != NULL) ? 0 : -1); -} - -/** - * @brief Removes an element both from the doubly linked list and by setting key and value both to NULL. - * - * Removes an element from the bucket list of the - * hash map. Removing sets the buckets key and - * value to NULL. - * If the specified key already has been removed, - * this function will do nothing. - * - * @param[in] map Pointer to the hash map to remove from - * and may NOT be NULL, so take caution. - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - */ -void iscsi_hashmap_remove(iscsi_hashmap *map, const uint8_t *key, const size_t key_size) -{ - const uint32_t hash = iscsi_hashmap_key_hash_data( key, key_size ); - iscsi_hashmap_bucket *entry = iscsi_hashmap_find_entry( map, key, key_size, hash ); - - if ( entry->key != NULL ) { - iscsi_list_remove( &entry->node ); - - map->count--; - - entry->key = NULL; - entry->value = NULL; - } -} - -/** - * @brief Removes an element both from the doubly linked list and by setting key and value both to NULL and but invokes a callback function before actual removal. - * - * Removes an element from the bucket list of the - * hash map.\n - * Removing sets the buckets key and - * value to NULL. A callback function is invoked - * if the key to be removed is found in the - * bucket list and allows, e.g. to free any - * resources associated with the key. If the key - * is not found, this function will do nothing. - * - * @param[in] map Pointer to the hash map to remove from - * and may NOT be NULL, so take caution. - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] callback Callback function which allows, - * for example, a dallocation of resources for - * the key and value pair to be removed. The - * function is invoked just before marking the - * key / value pair as removed. This may NOT - * be NULL, so take caution. - * @param[in,out] user_data Pointer to user specific data - * passed to the callback function in case - * more information is needed. - */ -void iscsi_hashmap_remove_free(iscsi_hashmap *map, const uint8_t *key, const size_t key_size, iscsi_hashmap_callback callback, uint8_t *user_data) -{ - const uint32_t hash = iscsi_hashmap_key_hash_data( key, key_size ); - iscsi_hashmap_bucket *entry = iscsi_hashmap_find_entry( map, key, key_size, hash ); - - if ( entry->key != NULL ) { - iscsi_list_remove( &entry->node ); - - map->count--; - - callback( entry->key, entry->key_size, entry->value, user_data ); - - entry->key = NULL; - entry->value = NULL; - } -} - -/** - * @brief Retrieves the number of elements of the hash map. - * - * Returns the number of elements stored in the - * specified hash map. - * - * @param[in] map Pointer to the hash map to count the - * number of elements, may NOT be NULL, so - * take caution. - * @return Number of elements currently in use by the - * hash map. - */ -uint iscsi_hashmap_size(const iscsi_hashmap *map) -{ - return map->count; -} - -/** - * @brief Iterator with callback function invoked on each element. - * - * An iterator through the elements of a - * specified hash map which uses a callback - * function for each element, which also - * can abort the iteration, if necessary.\n - * It is safe to remove the current iterating - * element in the callback function from the - * hash map. - * - * @param[in] map Pointer to the hash map to iterate - * through, may NOT be NULL, so take caution. - * @param[in] callback Callback function to be - * invoked for each element. If the return - * value of the callback function is below - * zero, the iteration will stop. - * @param[in,out] user_data Pointer to user specific data - * passed to the callback function in case more - * information is needed. - * @return The return code from the last invoked - * callback function. A negative value indicates - * an abortion of the iteration process. - */ -int iscsi_hashmap_iterate(iscsi_hashmap *map, iscsi_hashmap_callback callback, uint8_t *user_data) -{ - iscsi_hashmap_bucket *current; - iscsi_hashmap_bucket *tmp; - int err = 0; - - iscsi_list_foreach_safe_node ( &map->list, current, tmp ) { - if ( current->key == NULL ) - continue; - - err = callback( current->key, current->key_size, current->value, user_data ); - - if ( err < 0 ) - break; - } - - return err; -} - - -/// iSCSI global vector. MUST be initialized with iscsi_create before any iSCSI functions are used. -iscsi_globals *iscsi_globvec = NULL; - -/// Read/write lock for iSCSI global vector. MUST be initialized with iscsi_create before any iSCSI functions are used. -pthread_rwlock_t iscsi_globvec_rwlock; - - -/// iSCSI connection negotation key and value pair lookup table. -static const iscsi_key_value_pair_lut_entry iscsi_connection_key_value_pair_lut[] = { - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_HEADER_DIGEST, (uint8_t *) "None", (uint8_t *) "CRC32C\0None\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_LIST, 0 }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_DIGEST, (uint8_t *) "None", (uint8_t *) "CRC32C\0None\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_LIST, 0 }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_RECV_DS_LEN, (uint8_t *) "8192", (uint8_t *) "512\016777215\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_MULTI_NEGOTIATION | ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_OVERRIDE_DEFAULT }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_OF_MARKER, (uint8_t *) "No", (uint8_t *) "Yes\0No\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_AND, 0 }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IF_MARKER, (uint8_t *) "No", (uint8_t *) "Yes\0No\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_AND, 0 }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_OF_MARK_INT, (uint8_t *) "1", (uint8_t *) "1\0""65535\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, 0 }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IF_MARK_INT, (uint8_t *) "1", (uint8_t *) "1\0""65535\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, 0 }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD, (uint8_t *) "None", (uint8_t *) "CHAP\0None\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_LIST, 0 }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_A, (uint8_t *) "5", (uint8_t *) "5\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_LIST, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_CHAP_TYPE }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_N, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_CHAP_TYPE }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_R, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_CHAP_TYPE }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_I, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_CHAP_TYPE }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_C, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_CHAP_TYPE }, - { NULL, NULL, NULL, ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_INVALID, 0 } -}; - -/// iSCSI session negotation key and value pair lookup table. -static const iscsi_key_value_pair_lut_entry iscsi_session_key_value_pair_lut[] = { - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_CONNECTIONS, (uint8_t *) "1", (uint8_t *) "1\0""65535\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_SEND_TARGETS, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_SPECIAL_HANDLING }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_NAME, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_TARGET_DECLARATIVE }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_INITIATOR_NAME, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, 0 }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ALIAS, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, 0 }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_INITIATOR_ALIAS, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, 0 }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS, (uint8_t *) "", (uint8_t *) "\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_TARGET_DECLARATIVE }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_PORTAL_GROUP_TAG, (uint8_t *) "1", (uint8_t *) "1\0""65535\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_DECLARATIVE, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_TARGET_DECLARATIVE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_INITIAL_R2T, (uint8_t *) "Yes", (uint8_t *) "Yes\0No\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_OR, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IMMEDIATE_DATA, (uint8_t *) "Yes", (uint8_t *) "Yes\0No\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_AND, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN, (uint8_t *) "262144", (uint8_t *) "512\0""16777215\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE | ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_USE_OTHER_MAX_VALUE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_FIRST_BURST_LEN, (uint8_t *) "65536", (uint8_t *) "512\0""16777215\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE | ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_USE_PREVIOUS_VALUE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_WAIT, (uint8_t *) "2", (uint8_t *) "0\0""3600\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MAX, 0 }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_RETAIN, (uint8_t *) "20", (uint8_t *) "0\0""3600\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, 0 }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_OUTSTANDING_R2T, (uint8_t *) "1", (uint8_t *) "1\0""65536\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_PDU_IN_ORDER, (uint8_t *) "Yes", (uint8_t *) "Yes\0No\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_OR, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_SEQ_IN_ORDER, (uint8_t *) "Yes", (uint8_t *) "Yes\0No\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_OR, ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE }, - { ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_ERR_RECOVERY_LEVEL, (uint8_t *) "0", (uint8_t *) "0\0""2\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN, 0 }, - { ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_SESSION_TYPE, (uint8_t *) "Normal", (uint8_t *) "Normal\0Discovery\0", ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE, 0 }, - { NULL, NULL, NULL, ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_INVALID, 0 } -}; - -/** - * @brief Initializes a global key and value pair with type and list / range informations for fast access. - * - * This function is used to initialize the iSCSI - * global key and value pair list containing - * the key types and allowed values. - * - * @param[in] key_value_pairs Pointer to key and value pair hash map - * which should store the global key and value - * informations, may NOT be NULL, so take caution. - * @param[in] lut Lookup table to use for initialization. - * NULL is not allowed here, so be careful. - * @return 0 on success, a negative error code otherwise. - */ -static int iscsi_global_key_value_pair_init(iscsi_hashmap *key_value_pairs, const iscsi_key_value_pair_lut_entry *lut) -{ - for ( uint i = 0U, j = 1U; lut[i].key != NULL; i++, j += j ) { - iscsi_key_value_pair *key_value_pair = (iscsi_key_value_pair *) malloc( sizeof(struct iscsi_key_value_pair) ); - - if ( key_value_pair == NULL ) { - logadd( LOG_ERROR, "iscsi_global_key_value_pair_init: Out of memory allocating key value pair" ); - - return -1; - } - - const uint key_len = (uint) (strlen( (char *) lut[i].key ) + 1U); - - key_value_pair->value = lut[i].value; - key_value_pair->list_range = lut[i].list_range; - key_value_pair->type = lut[i].type; - key_value_pair->flags = lut[i].flags; - key_value_pair->state_mask = j; - - const int rc = iscsi_hashmap_put( key_value_pairs, (uint8_t *) lut[i].key, key_len, (uint8_t *) key_value_pair ); - - if ( rc < 0 ) { - free( key_value_pair ); - - return rc; - } - } - - return 0; -} - -/** - * @brief Allocates and initializes the iSCSI global vector structure. - * - * This function MUST be called before any iSCSI - * related functions are used.\n - * It is safe to call this function if the iSCSI - * global vector already has been initialized - * in which case this function does nothing. - * - * @return 0 if the iSCSI global vector has been initialized - * successfully and is ready to use, a negative - * error code otherwise (memory exhausted). - */ -int iscsi_create() +static void iscsi_copy_kvp_int(const char *name, int *dest, const char *src) { - pthread_rwlock_wrlock( &iscsi_globvec_rwlock ); - - if ( iscsi_globvec == NULL ) { - iscsi_globals *globvec = (iscsi_globals *) malloc( sizeof(struct iscsi_globals) ); - - if ( globvec == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector" ); - - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->devices = iscsi_hashmap_create( _maxImages ); - - if ( globvec->devices == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector devices hash map" ); - - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - if ( pthread_rwlock_init( &globvec->devices_rwlock, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing read/write lock for iSCSI global vector devices hash map" ); - - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->portal_groups = iscsi_hashmap_create( 1U ); - - if ( globvec->portal_groups == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector portal groups hash map" ); - - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - if ( pthread_rwlock_init( &globvec->portal_groups_rwlock, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing read/write lock for iSCSI global vector portal groups hash map" ); - - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->target_nodes = iscsi_hashmap_create( _maxImages ); - - if ( globvec->target_nodes == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector target nodes hash map" ); - - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - if ( pthread_rwlock_init( &globvec->target_nodes_rwlock, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing read/write lock for iSCSI global vector target nodes hash map" ); - - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->sessions = iscsi_hashmap_create( _maxClients ); - - if ( globvec->sessions == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector sessions hash map" ); - - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - if ( pthread_rwlock_init( &globvec->sessions_rwlock, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing read/write lock for iSCSI global vector sessions hash map map" ); - - iscsi_hashmap_destroy( globvec->sessions ); - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->session_key_value_pairs = iscsi_hashmap_create( ((sizeof(iscsi_session_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1) ); - - if ( globvec->session_key_value_pairs == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector session key and value pairs hash map" ); - - pthread_rwlock_destroy( &globvec->sessions_rwlock ); - iscsi_hashmap_destroy( globvec->sessions ); - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - int rc = iscsi_global_key_value_pair_init( globvec->session_key_value_pairs, &iscsi_session_key_value_pair_lut[0] ); - - if ( rc < 0 ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing iSCSI global vector session key and value pairs hash map" ); - - iscsi_hashmap_iterate( globvec->session_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->session_key_value_pairs ); - pthread_rwlock_destroy( &globvec->sessions_rwlock ); - iscsi_hashmap_destroy( globvec->sessions ); - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->connection_key_value_pairs = iscsi_hashmap_create( ((sizeof(iscsi_connection_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1) ); - - if ( globvec->connection_key_value_pairs == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector connection key and value pairs hash map" ); - - iscsi_hashmap_iterate( globvec->session_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->session_key_value_pairs ); - pthread_rwlock_destroy( &globvec->sessions_rwlock ); - iscsi_hashmap_destroy( globvec->sessions ); - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - rc = iscsi_global_key_value_pair_init( globvec->connection_key_value_pairs, &iscsi_connection_key_value_pair_lut[0] ); - - if ( rc < 0 ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing iSCSI global vector connection key and value pairs hash map" ); - - iscsi_hashmap_iterate( globvec->connection_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->connection_key_value_pairs ); - iscsi_hashmap_iterate( globvec->session_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->session_key_value_pairs ); - pthread_rwlock_destroy( &globvec->sessions_rwlock ); - iscsi_hashmap_destroy( globvec->sessions ); - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->scsi_device_config = iscsi_hashmap_create( 0U ); - - if ( globvec->scsi_device_config == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while allocating iSCSI global vector SCSI device configuration" ); - - iscsi_hashmap_iterate( globvec->connection_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->connection_key_value_pairs ); - iscsi_hashmap_iterate( globvec->session_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->session_key_value_pairs ); - pthread_rwlock_destroy( &globvec->sessions_rwlock ); - iscsi_hashmap_destroy( globvec->sessions ); - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - if ( pthread_mutex_init( &globvec->scsi_device_config_mutex, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing mutex for iSCSI global vector SCSI device configuration" ); - - iscsi_hashmap_destroy( globvec->scsi_device_config ); - iscsi_hashmap_iterate( globvec->connection_key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->connection_key_value_pairs ); - iscsi_hashmap_iterate( globvec->session_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->session_key_value_pairs ); - pthread_rwlock_destroy( &globvec->sessions_rwlock ); - iscsi_hashmap_destroy( globvec->sessions ); - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_destroy( globvec->target_nodes ); - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_destroy( globvec->portal_groups ); - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_destroy( globvec->devices ); - free( globvec ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return -1; - } - - globvec->flags = (ISCSI_GLOBALS_FLAGS_INIT_R2T | ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA | ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER | ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER | ISCSI_GLOBALS_FLAGS_SCSI_IO_REMOVABLE | ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_PROTECT); - globvec->target_name_check = ISCSI_GLOBALS_TARGET_NAME_CHECK_FULL; - globvec->max_sessions = 0U; - globvec->header_digest = 0; - globvec->data_digest = 0; - globvec->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_DIRECT; - globvec->max_recv_ds_len = ISCSI_DEFAULT_RECV_DS_LEN; - globvec->max_session_conns = ISCSI_GLOBALS_DEFAULT_MAX_CONNECTIONS; - globvec->max_outstanding_r2t = ISCSI_GLOBALS_DEFAULT_MAX_OUTSTANDING_R2T; - globvec->default_time_to_wait = ISCSI_GLOBALS_DEFAULT_TIME_TO_WAIT; - globvec->default_time_to_retain = ISCSI_GLOBALS_DEFAULT_TIME_TO_RETAIN; - globvec->first_burst_len = ISCSI_GLOBALS_DEFAULT_FIRST_BURST_LEN; - globvec->max_burst_len = ISCSI_GLOBALS_DEFAULT_MAX_BURST_LEN; - globvec->err_recovery_level = ISCSI_GLOBALS_DEFAULT_ERR_RECOVERY_LEVEL; - globvec->chap_group = 0L; - globvec->scsi_physical_block_size = ISCSI_SCSI_EMU_PHYSICAL_BLOCK_SIZE; - globvec->scsi_physical_block_size_shift = iscsi_get_log2_of_pow2( globvec->scsi_physical_block_size ); - globvec->scsi_logical_block_size = ISCSI_SCSI_EMU_BLOCK_SIZE; - globvec->scsi_logical_block_size_shift = iscsi_get_log2_of_pow2( globvec->scsi_logical_block_size ); - - iscsi_config_load( globvec ); - - iscsi_globvec = globvec; - } - - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return 0; -} - -/** - * @brief Deallocates all resources acquired by iscsi_create. - * - * This function MUST be called before program termination - * for ensuring proper clean up.\n - * After this function returns, calling any iSCSI related - * function except iscsi_create is strictly forbidden.\n - * It is safe to call this function if the iSCSI global - * vector already has been destroyed in which case this - * function does nothing. - */ -void iscsi_destroy() -{ - pthread_rwlock_wrlock( &iscsi_globvec_rwlock ); - - iscsi_globals *globvec = iscsi_globvec; - - if ( globvec != NULL ) { - iscsi_globvec = NULL; - - pthread_mutex_destroy( &globvec->scsi_device_config_mutex ); - iscsi_hashmap_iterate( globvec->scsi_device_config, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->scsi_device_config ); - globvec->scsi_device_config = NULL; - - iscsi_hashmap_iterate( globvec->connection_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->connection_key_value_pairs ); - globvec->connection_key_value_pairs = NULL; - - iscsi_hashmap_iterate( globvec->session_key_value_pairs, iscsi_hashmap_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( globvec->session_key_value_pairs ); - globvec->session_key_value_pairs = NULL; - - pthread_rwlock_destroy( &globvec->sessions_rwlock ); - iscsi_hashmap_iterate( globvec->sessions, iscsi_session_destroy_callback, NULL ); - iscsi_hashmap_destroy( globvec->sessions ); - globvec->sessions = NULL; - - pthread_rwlock_destroy( &globvec->target_nodes_rwlock ); - iscsi_hashmap_iterate( globvec->target_nodes, iscsi_target_node_destroy_callback, NULL ); - iscsi_hashmap_destroy( globvec->target_nodes ); - globvec->target_nodes = NULL; - - pthread_rwlock_destroy( &globvec->portal_groups_rwlock ); - iscsi_hashmap_iterate( globvec->portal_groups, iscsi_portal_group_destroy_callback, NULL ); - iscsi_hashmap_destroy( globvec->portal_groups ); - globvec->portal_groups = NULL; - - pthread_rwlock_destroy( &globvec->devices_rwlock ); - iscsi_hashmap_iterate( globvec->devices, iscsi_device_destroy_callback, NULL ); - iscsi_hashmap_destroy( globvec->devices ); - globvec->devices = NULL; - - free( globvec ); - } - - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); -} - -/** - * @brief Parses an INI configuration value and returns an integer representation of string with special boolean and suffixes handling. - * - * This function also handles boolean values 'true', - * 'yes', 'on', 'enabled' and 'activated', returning 1 - * for them, as well as 'false', 'no', 'off', 'disabled' - * and 'deactivated' having a return value of 0.\n - * Also the suffixes 'm' for minutes, 'h' for hours and - * 'd' for days are understood as time units.\n - * SI units 'K', 'M', 'G', 'T', 'P' and 'E' are - * understood as well.\n - * If a 'b' or 'B' follows, 1000 will be used as a - * multiplier instead of 1024.\n - * Parsing will be internally done in 64 bits and the - * final result is clamped between -2147483647 and - * 2147483647. - * - * @param[in] value Pointer to string for parsing. May - * NOT be NULL, so be careful. - * @return Parsed integer value or -2147483648 - * in case of an error. - */ -static int32_t iscsi_config_parse_int(const uint8_t *value) -{ - if ( *value == '\0' ) - return -2147483648L; - - if ( (strcasecmp( (char *) value, "true" ) == 0) || (strcasecmp( (char *) value, "yes" ) == 0) || (strcasecmp( (char *) value, "on" ) == 0) || (strcasecmp( (char *) value, "enabled" ) == 0) || (strcasecmp( (char *) value, "activated" ) == 0) ) - return 1L; - else if ( (strcasecmp( (char *) value, "false" ) == 0) || (strcasecmp( (char *) value, "no" ) == 0) || (strcasecmp( (char *) value, "off" ) == 0) || (strcasecmp( (char *) value, "disabled" ) == 0) || (strcasecmp( (char *) value, "deactivated" ) == 0) ) - return 0L; - - uint8_t *val_end; - int64_t rc = (int64_t) strtoll( (char *) value, (char **) &val_end, 10 ); - - if ( value == val_end ) - return -2147483648L; - - while ( (*val_end == '\t') || (*val_end == ' ') ) { - val_end++; - } - - switch ( *val_end ) { - case '\0' : { - break; - } - case 'm' : { - rc *= 60LL; - val_end++; - - break; - } - case 'h' : { - rc *= 3600LL; - val_end++; + long long res = 0; + const char *end = NULL; - break; - } - case 'd' : { - rc *= 86400LL; - val_end++; - - break; - } - default : { - const uint8_t c = (*val_end++ | ('a' - 'A')); - const bool ten = ((*val_end | ('a' - 'A')) == 'b'); - - switch ( c ) { - case 'k' : { - rc = (ten ? (rc * 1000LL) : (rc << 10LL)); - - break; - } - case 'm' : { - rc = (ten ? (rc * 1000000LL) : (rc << 20LL)); - - break; - } - case 'g' : { - rc = (ten ? (rc * 1000000000LL) : (rc << 30LL)); - - break; - } - case 't' : { - rc = (ten ? (rc * 1000000000000LL) : (rc << 40LL)); - - break; - } - case 'p' : { - rc = (ten ? (rc * 1000000000000000LL) : (rc << 50LL)); - - break; - } - case 'e' : { - rc = (ten ? (rc * 1000000000000000000LL) : (rc << 60LL)); - - break; - } - default : { - return -2147483648L; - - break; - } - } - - if ( ten ) - val_end++; - - break; - } + if ( *dest != -1 ) { + logadd( LOG_DEBUG1, "Received duplicate entry for key '%s', ignoring (new: %s, old: %d)", name, src, *dest ); + return; } - if ( *val_end != '\0' ) - return -2147483648L; - - if ( rc < -2147483647LL ) - rc = -2147483647LL; - else if ( rc > 2147483647LL ) - rc = 2147483647LL; - - return (int32_t) rc; -} - -/** - * @brief Callback function from DNBD3 INI parser invoked for handling a specific key=value pair in a specified INI section. - * - * This function checks whether the INI - * section belongs to the iSCSI server - * configuration part.\n - * Currently, the sections 'iscsi' and - * 'scsi' for the SCSI emulation are - * processed. - * - * @param[in] user_data Pointer to iSCSI global vector where - * to store the configuration data. May - * NOT be NULL, so be careful. - * @param[in] section Pointer to currently processing - * INI section. NULL is NOT allowed here, - * take caution. - * @param[in] key Pointer to currently processing INI - * key. May NOT be NULL, so be careful. - * @param[in] value Pointer to currently processing INI - * value. NULL is prohibited, so take - * caution. - * @retval 1 INI parsing was successful. - * @retval 0 An error occured during INI parsing. - */ -static int iscsi_config_load_from_ini(void *user_data, const char *section, const char *key, const char *value) -{ - iscsi_globals *globvec = (iscsi_globals *) user_data; - - if ( strcasecmp( section, ISCSI_GLOBALS_SECTION_ISCSI ) == 0 ) { - const int32_t num_value = iscsi_config_parse_int( (uint8_t *) value ); - - if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_ISCSI_KEY_TARGET_NAME_CHECK ) == 0 ) { - if ( strcasecmp( value, "None" ) == 0 ) - globvec->target_name_check = ISCSI_GLOBALS_TARGET_NAME_CHECK_NONE; - else if ( strcasecmp( value, "Relaxed" ) == 0 ) - globvec->target_name_check = ISCSI_GLOBALS_TARGET_NAME_CHECK_RELAXED; - else - globvec->target_name_check = ISCSI_GLOBALS_TARGET_NAME_CHECK_FULL; - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_ISCSI_KEY_MAX_SESSIONS ) == 0 ) { - globvec->max_sessions = (uint) num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_HEADER_DIGEST ) == 0 ) { - globvec->header_digest = ((strcasecmp( value, "CRC32C" ) == 0) ? ISCSI_DIGEST_SIZE : 0); - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_DIGEST ) == 0 ) { - globvec->data_digest = ((strcasecmp( value, "CRC32C" ) == 0) ? ISCSI_DIGEST_SIZE : 0); - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_RECV_DS_LEN ) == 0 ) { - if ( (num_value >= 512L) && (num_value <= (int32_t) ISCSI_MAX_DS_SIZE) ) - globvec->max_recv_ds_len = num_value; - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_ISCSI_MAX_CONNECTIONS_PER_SESSIONS ) == 0 ) { - if ( (num_value > 0L) && (num_value <= 65535L) ) - globvec->max_session_conns = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_OUTSTANDING_R2T ) == 0 ) { - if ( (num_value > 0L) && (num_value <= 65536L) ) - globvec->max_outstanding_r2t = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_WAIT ) == 0 ) { - if ( (uint32_t) num_value <= 3600UL ) - globvec->default_time_to_wait = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_RETAIN ) == 0 ) { - if ( (uint32_t) num_value <= 3600UL ) - globvec->default_time_to_retain = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_FIRST_BURST_LEN ) == 0 ) { - if ( (num_value >= 512L) && (num_value <= (int32_t) ISCSI_MAX_DS_SIZE) ) - globvec->first_burst_len = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN ) == 0 ) { - if ( (num_value >= 512L) && (num_value <= (int32_t) ISCSI_MAX_DS_SIZE) ) - globvec->max_burst_len = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_INITIAL_R2T ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_INIT_R2T; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_INIT_R2T; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IMMEDIATE_DATA ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_PDU_IN_ORDER ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_SEQ_IN_ORDER ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_ERR_RECOVERY_LEVEL ) == 0 ) { - if ( (uint32_t) num_value <= 2UL ) - globvec->err_recovery_level = num_value; - } - } else if ( strcasecmp( section, ISCSI_GLOBALS_SECTION_SCSI ) == 0 ) { - int32_t num_value = iscsi_config_parse_int( (uint8_t *) value ); - - if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_DEVICE_TYPE ) == 0 ) { - if ( strcasecmp( value, "Sequential" ) == 0 ) - globvec->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_SEQ; - else if ( strcasecmp( value, "WriteOnce" ) == 0 ) - globvec->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_WORM; - else if ( strcasecmp( value, "ReadOnlyDirect" ) == 0 ) - globvec->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_RO_DIRECT; - else if ( strcasecmp( value, "OpticalMemory" ) == 0 ) - globvec->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_OPTICAL; - else if ( strcasecmp( value, "MediaChanger" ) == 0 ) - globvec->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_CHANGER; - else - globvec->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_DIRECT; - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_PHYSICAL_BLOCK_SIZE ) == 0 ) { - num_value = iscsi_align_pow2_ceil( num_value ); - - if ( (num_value >= 256L) && (num_value <= 32768L) ) { - globvec->scsi_physical_block_size = num_value; - globvec->scsi_physical_block_size_shift = iscsi_get_log2_of_pow2( num_value ); - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_LOGICAL_BLOCK_SIZE ) == 0 ) { - num_value = iscsi_align_pow2_ceil( num_value ); - - if ( (num_value >= 256L) && (num_value <= 32768L) ) { - globvec->scsi_logical_block_size = num_value; - globvec->scsi_logical_block_size_shift = iscsi_get_log2_of_pow2( num_value ); - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_REMOVABLE ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_SCSI_IO_REMOVABLE; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_SCSI_IO_REMOVABLE; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_UNMAP ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_SCSI_IO_UNMAP; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_SCSI_IO_UNMAP; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_NO_ROTATION ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_SCSI_IO_NO_ROTATION; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_SCSI_IO_NO_ROTATION; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_PHYSICAL_READ_ONLY ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_WRITE_PROTECT ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_PROTECT; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_PROTECT; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_WRITE_CACHE ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - globvec->flags |= ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_CACHE; - else - globvec->flags &= ~ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_CACHE; - } - } - } else if ( strncasecmp( section, ISCSI_GLOBALS_SECTION_SCSI_DEVICE_PREFIX, ISCSI_STRLEN(ISCSI_GLOBALS_SECTION_SCSI_DEVICE_PREFIX) ) == 0 ) { - uint8_t *pattern = (((uint8_t *) section) + ISCSI_STRLEN(ISCSI_GLOBALS_SECTION_SCSI_DEVICE_PREFIX)); - const uint key_len = (uint) (strlen( (char *) pattern ) + 1U); - - if ( key_len == 0U ) - return 0; - - uint8_t *hash_key = iscsi_hashmap_key_create( pattern, key_len ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_config_load_from_ini: Out of memory allocating memory for iSCSI SCSI device INI configuration section key" ); - - return 0; - } - - iscsi_scsi_device_config *scsi_device_config = NULL; - int rc = iscsi_hashmap_get( globvec->scsi_device_config, hash_key, key_len, (uint8_t **) &scsi_device_config ); - - if ( scsi_device_config == NULL ) { - scsi_device_config = (iscsi_scsi_device_config *) malloc( sizeof(struct iscsi_scsi_device_config) ); - - if ( scsi_device_config == NULL ) { - logadd( LOG_ERROR, "iscsi_config_load_from_ini: Out of memory allocating memory for iSCSI SCSI device configuration" ); - - iscsi_hashmap_key_destroy( hash_key ); - - return 0; - } - - scsi_device_config->flags = 0; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_INIT_R2T) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_INIT_R2T; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_IMMEDIATE_DATA; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_DATA_PDU_IN_ORDER; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_DATA_SEQ_IN_ORDER; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_REMOVABLE) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_REMOVABLE; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_UNMAP) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_UNMAP; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_NO_ROTATION) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_NO_ROTATION; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_PROTECT) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_PROTECT; - - if ( (globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_CACHE) != 0 ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_CACHE; - - scsi_device_config->header_digest = globvec->header_digest; - scsi_device_config->data_digest = globvec->data_digest; - scsi_device_config->scsi_device_type = globvec->scsi_device_type; - scsi_device_config->max_recv_ds_len = globvec->max_recv_ds_len; - scsi_device_config->max_session_conns = globvec->max_session_conns; - scsi_device_config->max_outstanding_r2t = globvec->max_outstanding_r2t; - scsi_device_config->default_time_to_wait = globvec->default_time_to_wait; - scsi_device_config->default_time_to_retain = globvec->default_time_to_retain; - scsi_device_config->first_burst_len = globvec->first_burst_len; - scsi_device_config->max_burst_len = globvec->max_burst_len; - scsi_device_config->err_recovery_level = globvec->err_recovery_level; - scsi_device_config->scsi_physical_block_size = globvec->scsi_physical_block_size; - scsi_device_config->scsi_physical_block_size_shift = globvec->scsi_physical_block_size_shift; - scsi_device_config->scsi_logical_block_size = globvec->scsi_logical_block_size; - scsi_device_config->scsi_logical_block_size_shift = globvec->scsi_logical_block_size_shift; - - rc = iscsi_hashmap_put( globvec->scsi_device_config, hash_key, key_len, (uint8_t *) scsi_device_config ); - - if ( rc < 0 ) { - free( scsi_device_config ); - iscsi_hashmap_key_destroy( hash_key ); - - return 0; - } - } else { - iscsi_hashmap_key_destroy( hash_key ); - } - - int32_t num_value = iscsi_config_parse_int( (uint8_t *) value ); - - if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_HEADER_DIGEST ) == 0 ) { - scsi_device_config->header_digest = ((strcasecmp( value, "CRC32C" ) == 0) ? ISCSI_DIGEST_SIZE : 0); - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_DIGEST ) == 0 ) { - scsi_device_config->data_digest = ((strcasecmp( value, "CRC32C" ) == 0) ? ISCSI_DIGEST_SIZE : 0); - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_RECV_DS_LEN ) == 0 ) { - if ( (num_value >= 512L) && (num_value <= (int32_t) ISCSI_MAX_DS_SIZE) ) - scsi_device_config->max_recv_ds_len = num_value; - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_ISCSI_MAX_CONNECTIONS_PER_SESSIONS ) == 0 ) { - if ( (num_value > 0L) && (num_value <= 65535L) ) - scsi_device_config->max_session_conns = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_OUTSTANDING_R2T ) == 0 ) { - if ( (num_value > 0L) && (num_value <= 65536L) ) - scsi_device_config->max_outstanding_r2t = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_WAIT ) == 0 ) { - if ( (uint32_t) num_value <= 3600UL ) - scsi_device_config->default_time_to_wait = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_RETAIN ) == 0 ) { - if ( (uint32_t) num_value <= 3600UL ) - scsi_device_config->default_time_to_retain = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_FIRST_BURST_LEN ) == 0 ) { - if ( (num_value >= 512L) && (num_value <= (int32_t) ISCSI_MAX_DS_SIZE) ) - scsi_device_config->first_burst_len = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN ) == 0 ) { - if ( (num_value >= 512L) && (num_value <= (int32_t) ISCSI_MAX_DS_SIZE) ) - scsi_device_config->max_burst_len = num_value; - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_INITIAL_R2T ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_FLAGS_INIT_R2T; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_FLAGS_INIT_R2T; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IMMEDIATE_DATA ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_PDU_IN_ORDER ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_SEQ_IN_ORDER ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER; - } - } else if ( strcasecmp( key, (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_ERR_RECOVERY_LEVEL ) == 0 ) { - if ( (uint32_t) num_value <= 2UL ) - scsi_device_config->err_recovery_level = num_value; - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_DEVICE_TYPE ) == 0 ) { - if ( strcasecmp( value, "Sequential" ) == 0 ) - scsi_device_config->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_SEQ; - else if ( strcasecmp( value, "WriteOnce" ) == 0 ) - scsi_device_config->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_WORM; - else if ( strcasecmp( value, "ReadOnlyDirect" ) == 0 ) - scsi_device_config->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_RO_DIRECT; - else if ( strcasecmp( value, "OpticalMemory" ) == 0 ) - scsi_device_config->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_OPTICAL; - else if ( strcasecmp( value, "MediaChanger" ) == 0 ) - scsi_device_config->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_CHANGER; - else - scsi_device_config->scsi_device_type = ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_DIRECT; - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_PHYSICAL_BLOCK_SIZE ) == 0 ) { - num_value = iscsi_align_pow2_ceil( num_value ); - - if ( (num_value >= 256L) && (num_value <= 32768L) ) { - scsi_device_config->scsi_physical_block_size = num_value; - scsi_device_config->scsi_physical_block_size_shift = iscsi_get_log2_of_pow2( num_value ); - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_LOGICAL_BLOCK_SIZE ) == 0 ) { - num_value = iscsi_align_pow2_ceil( num_value ); - - if ( (num_value >= 256L) && (num_value <= 32768L) ) { - scsi_device_config->scsi_logical_block_size = num_value; - scsi_device_config->scsi_logical_block_size_shift = iscsi_get_log2_of_pow2( num_value ); - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_REMOVABLE ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_REMOVABLE; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_REMOVABLE; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_UNMAP ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_UNMAP; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_UNMAP; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_NO_ROTATION ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_NO_ROTATION; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_NO_ROTATION; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_PHYSICAL_READ_ONLY ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_WRITE_PROTECT ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_PROTECT; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_PROTECT; - } - } else if ( strcasecmp( key, ISCSI_GLOBALS_SECTION_SCSI_KEY_WRITE_CACHE ) == 0 ) { - if ( num_value != -2147483648L ) { - if ( num_value != 0L ) - scsi_device_config->flags |= ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_CACHE; - else - scsi_device_config->flags &= ~ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_CACHE; - } - } + if ( *src == '\0' ) { + logadd( LOG_DEBUG1, "Empty value for numeric option '%s', ignoring", name ); + return; } + res = strtoll( src, (char **)&end, 10 ); // WTF why is the second arg not const char ** - return 1; -} - -/** - * @brief Loads iSCSI server configuration from INI file. - * - * This function parses the INI configuration file - * and assigns it to the config section of the iSCSI - * global vector. - * - * @param[in] globvec Pointer to iSCSI global vector where to store - * the parsed and processed results. May NOT be - * NULL, so be careful. - * - * @return Number of configuration keys parsed or - * a neagtive error code otherwise. - */ -int iscsi_config_load(iscsi_globals *globvec) -{ - char *name = (char *) iscsi_sprintf_alloc( "%s/%s", _configDir, CONFIG_FILENAME ); - - if ( name == NULL ) - return -1; - - if ( !file_isReadable( name ) ) { - free( name ); - - return 0; + if ( end == NULL ) { + logadd( LOG_DEBUG1, "base 10 not valid! O.o" ); + return; } - - pthread_mutex_lock( &globvec->scsi_device_config_mutex ); - iscsi_hashmap_iterate( globvec->scsi_device_config, iscsi_hashmap_key_destroy_value_callback, NULL ); - ini_parse( name, iscsi_config_load_from_ini, (void *) globvec ); - free( name ); - - name = (char *) iscsi_sprintf_alloc( "%s/%s", _configDir, ISCSI_GLOBALS_CONFIG_FILENAME ); - - if ( name == NULL ) { - pthread_mutex_unlock( &globvec->scsi_device_config_mutex ); - - return -1; + if ( *end != '\0' ) { + logadd( LOG_DEBUG1, "Invalid non-numeric character in value for '%s': '%c' (0x%02x), ignoring option", + name, (int)*end, (int)*end ); + return; } - - if ( !file_isReadable( name ) ) { - pthread_mutex_unlock( &globvec->scsi_device_config_mutex ); - free( name ); - - return 0; + if ( res < 0 ) { + res = 0; + } else if ( res > INT_MAX ) { + res = INT_MAX; } - - ini_parse( name, iscsi_config_load_from_ini, (void *) globvec ); - pthread_mutex_unlock( &globvec->scsi_device_config_mutex ); - free( name ); - - return 1; + *dest = (int)res; } -/** - * @brief Finds an iSCSI SCSI device configuration by name using pattern matching. - * - * Callback function for each element while iterating - * through the iSCSI SCSI device configuration hash - * map. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL creates an - * empty key assignment. - * @param[in,out] user_data Pointer to a data structure - * containing the iSCSI SCSI device configuration and - * the name to be searched for and may NOT be NULL, - * so be careful. - * @retval -1 The SCSI device configuration has been found and - * stored in the result structure. Therefore, no - * further searching is needed. - * @retval -2 An error occured during matching the - * name. - * @retval 0 The SCSI device configuration has not been found - * yet. - */ -int iscsi_config_get_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) +static void iscsi_copy_kvp_str(const char *name, const char **dest, const char *src) { - iscsi_scsi_device_config_find *scsi_device_config_find = (iscsi_scsi_device_config_find *) user_data; - const int rc = fnmatch( (char *) key, (char *) scsi_device_config_find->name, (FNM_PATHNAME | FNM_PERIOD) ); - - if ( rc == FNM_NOMATCH ) - return 0; - - if ( rc != 0 ) - return -2; - - scsi_device_config_find->scsi_device_config = (iscsi_scsi_device_config *) value; - - return -1; -} - -/** - * @brief Retrieves a configuration value either from the iSCSI global vector or for a specified SCSI device name. - * - * This function uses wildcard matching - * only if the SCSI device name does NOT - * have a direct match. - * - * @param[in] name Pointer to SCSI configuration name to - * be retrieved or NULL if the iSCSI - * global vector configuration should - * be accessed instead. - * @param[in] type Type of configuration to be - * retrieved. - * @return The requested configuration value or a - * negative error code otherwise. - */ -int32_t iscsi_config_get(uint8_t *name, const int type) -{ - if ( name != NULL ) { - const uint key_len = (uint) (strlen( (char *) name ) + 1U); - uint8_t *hash_key = iscsi_hashmap_key_create( name, key_len ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_config_get: Out of memory allocating memory for iSCSI SCSI device configuration key" ); - - return -1L; - } - - pthread_mutex_lock( &iscsi_globvec->scsi_device_config_mutex ); - - iscsi_scsi_device_config *scsi_device_config = NULL; - int rc = iscsi_hashmap_get( iscsi_globvec->scsi_device_config, hash_key, key_len, (uint8_t **) &scsi_device_config ); - - if ( rc < 0 ) { - iscsi_scsi_device_config_find scsi_device_config_find = {NULL, name}; - - rc = iscsi_hashmap_iterate(iscsi_globvec->scsi_device_config, iscsi_config_get_callback, (uint8_t *) &scsi_device_config_find ); - - scsi_device_config = scsi_device_config_find.scsi_device_config; - - if ( scsi_device_config != NULL ) { - iscsi_scsi_device_config *new_scsi_device_config = (iscsi_scsi_device_config *) malloc( sizeof(struct iscsi_scsi_device_config) ); - - if ( new_scsi_device_config == NULL ) { - logadd( LOG_ERROR, "iscsi_config_get: Out of memory allocating memory for new iSCSI SCSI device configuration" ); - - pthread_mutex_unlock( &iscsi_globvec->scsi_device_config_mutex ); - iscsi_hashmap_key_destroy( hash_key ); - - return -1L; - } - - memcpy( new_scsi_device_config, scsi_device_config, sizeof(struct iscsi_scsi_device_config) ); - rc = iscsi_hashmap_put( iscsi_globvec->scsi_device_config, hash_key, key_len, (uint8_t *) new_scsi_device_config ); - - if ( rc < 0 ) { - pthread_mutex_unlock( &iscsi_globvec->scsi_device_config_mutex ); - free( new_scsi_device_config ); - iscsi_hashmap_key_destroy( hash_key ); - - return -1L; - } - - scsi_device_config = new_scsi_device_config; - hash_key = NULL; - } - } - - pthread_mutex_unlock( &iscsi_globvec->scsi_device_config_mutex ); - - if ( hash_key != NULL ) - iscsi_hashmap_key_destroy( hash_key ); - - if ( scsi_device_config != NULL ) { - switch ( type ) { - case ISCSI_GLOBALS_CONFIG_TYPE_HEADER_DIGEST : { - return scsi_device_config->header_digest; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_DATA_DIGEST : { - return scsi_device_config->data_digest; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_RECV_DS_LEN : { - return scsi_device_config->max_recv_ds_len; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_SESSION_CONNS : { - return scsi_device_config->max_session_conns; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_OUTSTANDING_R2T : { - return scsi_device_config->max_outstanding_r2t; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_DEFAULT_TIME_TO_WAIT : { - return scsi_device_config->default_time_to_wait; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_DEFAULT_TIME_TO_RETAIN : { - return scsi_device_config->default_time_to_retain; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FIRST_BURST_LEN : { - return scsi_device_config->first_burst_len; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_BURST_LEN : { - return scsi_device_config->max_burst_len; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_ERR_RECOVERY_LEVEL : { - return scsi_device_config->err_recovery_level; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE : { - return scsi_device_config->scsi_physical_block_size; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_DEVICE_TYPE : { - return scsi_device_config->scsi_device_type; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE_SHIFT : { - return scsi_device_config->scsi_physical_block_size_shift; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE : { - return scsi_device_config->scsi_logical_block_size; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE_SHIFT : { - return scsi_device_config->scsi_logical_block_size_shift; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_INIT_R2T : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_INIT_R2T) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_IMMEDIATE_DATA : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_IMMEDIATE_DATA) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_DATA_PDU_IN_ORDER : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_DATA_PDU_IN_ORDER) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_DATA_SEQ_IN_ORDER : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_DATA_SEQ_IN_ORDER) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_REMOVABLE : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_REMOVABLE) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_UNMAP : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_UNMAP) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_NO_ROTATION : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_NO_ROTATION) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_PROTECT : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_PROTECT) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_CACHE : { - return (((scsi_device_config->flags & ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_CACHE) != 0) ? 1L : 0L); - - break; - } - default : { - return -1L; - - break; - } - } - } - } - - switch ( type ) { - case ISCSI_GLOBALS_CONFIG_TYPE_HEADER_DIGEST : { - return iscsi_globvec->header_digest; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_DATA_DIGEST : { - return iscsi_globvec->data_digest; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_RECV_DS_LEN : { - return iscsi_globvec->max_recv_ds_len; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_SESSION_CONNS : { - return iscsi_globvec->max_session_conns; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_OUTSTANDING_R2T : { - return iscsi_globvec->max_outstanding_r2t; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_DEFAULT_TIME_TO_WAIT : { - return iscsi_globvec->default_time_to_wait; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_DEFAULT_TIME_TO_RETAIN : { - return iscsi_globvec->default_time_to_retain; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FIRST_BURST_LEN : { - return iscsi_globvec->first_burst_len; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_MAX_BURST_LEN : { - return iscsi_globvec->max_burst_len; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_ERR_RECOVERY_LEVEL : { - return iscsi_globvec->err_recovery_level; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_DEVICE_TYPE : { - return iscsi_globvec->scsi_device_type; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE : { - return iscsi_globvec->scsi_physical_block_size; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE_SHIFT : { - return iscsi_globvec->scsi_physical_block_size_shift; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE : { - return iscsi_globvec->scsi_logical_block_size; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE_SHIFT : { - return iscsi_globvec->scsi_logical_block_size_shift; - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_INIT_R2T : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_INIT_R2T) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_IMMEDIATE_DATA : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_DATA_PDU_IN_ORDER : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_DATA_SEQ_IN_ORDER : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_REMOVABLE : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_REMOVABLE) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_UNMAP : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_UNMAP) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_NO_ROTATION : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_NO_ROTATION) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_PROTECT : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_PROTECT) != 0) ? 1L : 0L); - - break; - } - case ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_CACHE : { - return (((iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_CACHE) != 0) ? 1L : 0L); - - break; - } - default : { - return -1L; - - break; - } + if ( *dest != NULL ) { + logadd( LOG_DEBUG1, "Received duplicate entry for key '%s', ignoring (new: %s, old: %s)", name, src, *dest ); + return; } - - return -1L; + *dest = src; } /** @@ -2371,76 +200,65 @@ int32_t iscsi_config_get(uint8_t *name, const int type) * a negative value in case of an error. This can be used for * incrementing the offset to the next key / value pair. */ -static int iscsi_parse_text_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *packet_data, const uint32_t len) +static int iscsi_parse_text_key_value_pair(iscsi_negotiation_kvp *key_value_pairs, const char *packet_data, const uint32_t len) { - const uint key_val_len = (uint) strnlen( (char *) packet_data, len ); - const uint8_t *key_end = memchr( packet_data, '=', key_val_len ); - - if ( key_end == NULL ) { - logadd( LOG_ERROR, "iscsi_parse_text_key_value_pair: Key / value separator '=' not found" ); + int key_val_len = (int) strnlen( packet_data, len ); + const char *key_end = memchr( packet_data, '=', key_val_len ); + if ( key_val_len == (int)len ) { + logadd( LOG_DEBUG1, "iscsi_parse_text_key_value_pair: Final key/value pair not null-terminated, not spec compliant, aborting" ); return -1; } + // Account for the trailing nullchar (for return value), which we also consumed + key_val_len++; + + if ( key_end == NULL ) { + logadd( LOG_DEBUG1, "iscsi_parse_text_key_value_pair: Key/value separator '=' not found, ignoring" ); + return key_val_len; + } const uint key_len = (uint) (key_end - packet_data); + const uint val_len = (uint) (key_val_len - key_len - 1); if ( key_len == 0U ) { - logadd( LOG_ERROR, "iscsi_parse_text_key_value_pair: Empty key found which is NOT allowed according to iSCSI specs" ); - - return -1; + logadd( LOG_DEBUG1, "iscsi_parse_text_key_value_pair: Empty key, not allowed according to iSCSI specs, ignoring" ); + return key_val_len; } if ( key_len > ISCSI_TEXT_KEY_MAX_LEN ) { - logadd( LOG_ERROR, "iscsi_parse_text_key_value_pair: Key value is too large (max 63 bytes)" ); - - return -1; + logadd( LOG_DEBUG1, "iscsi_parse_text_key_value_pair: Key is too long (max %d bytes), ignoring", ISCSI_TEXT_KEY_MAX_LEN ); + return key_val_len; } - const uint hash_key_len = (key_len + 1U); - uint8_t *hash_key = iscsi_hashmap_key_create( packet_data, hash_key_len ); - - if ( hash_key == NULL ) - return -1; - - hash_key[key_len] = '\0'; - - if ( iscsi_hashmap_contains( key_value_pairs, hash_key, hash_key_len ) ) { - logadd( LOG_ERROR, "iscsi_parse_text_key_value_pair: Forbidden duplicate key discovered" ); - - iscsi_hashmap_key_destroy( hash_key ); - - return -1; + if ( val_len > ISCSI_TEXT_VALUE_MAX_LEN ) { + logadd( LOG_DEBUG1, "iscsi_parse_text_key_value_pair: Value for '%.*s' is too long (max %d bytes), ignoring", + (int)key_len, packet_data, ISCSI_TEXT_VALUE_MAX_LEN ); + return key_val_len; } - const uint val_len = (uint) (strnlen( (char *) (key_end + 1U), (key_val_len - key_len - 1U) ) + 1U); - const uint max_len = (((strcmp( (char *) hash_key, "CHAP_C" ) == 0) || (strcmp( (char *) hash_key, "CHAP_R" ) == 0)) ? ISCSI_TEXT_VALUE_MAX_LEN : ISCSI_TEXT_VALUE_MAX_SIMPLE_LEN); - - if ( val_len > max_len ) { - logadd( LOG_ERROR, "iscsi_parse_text_key_value_pair: Value length larger than iSCSI specs allow" ); - - iscsi_hashmap_key_destroy( hash_key ); +#define COPY_KVP(type, key) \ + else if ( strncmp( packet_data, #key, key_len ) == 0 ) iscsi_copy_kvp_ ## type ( #key, &key_value_pairs->key, key_end + 1 ) - return -1; + if ( 0 ) {} + COPY_KVP( int, MaxRecvDataSegmentLength ); + COPY_KVP( int, MaxBurstLength ); + COPY_KVP( int, FirstBurstLength ); + COPY_KVP( int, MaxConnections ); + COPY_KVP( int, ErrorRecoveryLevel ); + COPY_KVP( str, SessionType ); + COPY_KVP( str, AuthMethod ); + COPY_KVP( str, SendTargets ); + COPY_KVP( str, HeaderDigest ); + COPY_KVP( str, DataDigest ); + COPY_KVP( str, InitiatorName ); + COPY_KVP( str, TargetName ); + else { + logadd( LOG_DEBUG1, "iscsi_parse_text_key_value_pair: Unknown option: '%.*s'", (int)key_len, packet_data ); } - uint8_t *hash_val = (uint8_t *) malloc( ISCSI_ALIGN(val_len, ISCSI_TEXT_VALUE_ALIGN) ); - - if ( hash_val == NULL ) { - logadd( LOG_ERROR, "iscsi_parse_text_key_value_pair: Out of memory allocating memory for value string" ); - - iscsi_hashmap_key_destroy( hash_key ); - - return -1; - } +#undef COPY_KVP - memcpy( hash_val, (key_end + 1), val_len ); - - const int rc = iscsi_hashmap_put( key_value_pairs, hash_key, hash_key_len, hash_val ); - - if ( rc < 0 ) - return -1; - - return (int) (hash_key_len + val_len); + return (int)key_val_len; } /** @@ -2450,84 +268,35 @@ static int iscsi_parse_text_key_value_pair(iscsi_hashmap *key_value_pairs, const * data amd puts the extracted data into a hash map to be used by * the iSCSI implementation. * - * @param[in] key_value_pairs Pointer to hash map that should contain all + * @param[in] pairs struct to write all key-value-pair options from packet to * extracted keys and pairs. May NOT be NULL, so take caution. * @param[in] packet_data Pointer to first key and value pair to * be parsed. NULL is an illegal value here, so be careful. * @param[in] len Length of the remaining packet data. - * @param[in] c_bit Non-zero value of C bit was set in previously. - * @param[in] partial_pairs Array of partial pair pointers in - * case C bit was set (multiple iSCSI packets for text data). * @retval -1 An error occured during parsing key. * @retval 0 Key and value pair was parsed successfully and was added to * hash map. */ -int iscsi_parse_key_value_pairs(iscsi_hashmap *key_value_pairs, const uint8_t *packet_data, uint len, int c_bit, uint8_t **partial_pairs) +static int iscsi_parse_login_key_value_pairs(iscsi_negotiation_kvp *pairs, const uint8_t *packet_data, uint len) { + memset( pairs, -1 , sizeof(*pairs) ); + pairs->SessionType = NULL; + pairs->AuthMethod = NULL; + pairs->SendTargets = NULL; + pairs->HeaderDigest = NULL; + pairs->DataDigest = NULL; + pairs->InitiatorName = NULL; + pairs->TargetName = NULL; + if ( len == 0U ) return 0; // iSCSI specs don't allow zero length - if ( (partial_pairs != NULL) && (*partial_pairs != NULL) ) { // Strip partial text parameters in case C bit was enabled previously - uint key_val_pair_len; - - for (key_val_pair_len = 0; (key_val_pair_len < len) && packet_data[key_val_pair_len] != '\0'; key_val_pair_len++) { - } - - uint8_t *tmp_partial_buf = iscsi_sprintf_alloc( "%s%s", *partial_pairs, (const char *) packet_data ); - - if ( tmp_partial_buf == NULL ) - return -1; - - const int rc = iscsi_parse_text_key_value_pair( key_value_pairs, tmp_partial_buf, (uint32_t) (key_val_pair_len + strlen( (char *) *partial_pairs )) ); - free( tmp_partial_buf ); - - if ( rc < 0 ) - return -1; - - free( *partial_pairs ); - *partial_pairs = NULL; - - packet_data += (key_val_pair_len + 1); - len -= (key_val_pair_len + 1); - } - - if ( c_bit ) { // Strip partial parameters in case C bit was enabled previousley - if ( partial_pairs == NULL ) { - logadd( LOG_ERROR, "iscsi_parse_key_value_pairs: C bit set but missing partial parameter" ); - - return -1; - } - - uint key_val_pair_len; - - for (key_val_pair_len = (len - 1U); (packet_data[key_val_pair_len] != '\0') && (key_val_pair_len > 0U); key_val_pair_len--) { - } - - if ( key_val_pair_len != 0U ) - key_val_pair_len++; // NUL char found, don't copy to target buffer' - - *partial_pairs = (uint8_t *) malloc( ((len - key_val_pair_len) + 1U) ); - - if ( *partial_pairs == NULL ) { - logadd( LOG_ERROR, "iscsi_parse_key_value_pairs: Out of memory allocating partial parameter" ); - - return -1; - } - - memcpy( *partial_pairs, &packet_data[key_val_pair_len], (len - key_val_pair_len) ); - - if ( key_val_pair_len != 0U ) - len = (key_val_pair_len - 1U); - else - return 0; - } - int offset = 0; while ( ((uint) offset < len) && (packet_data[offset] != '\0') ) { - const int rc = iscsi_parse_text_key_value_pair( key_value_pairs, (packet_data + offset), (len - offset) ); + const int rc = iscsi_parse_text_key_value_pair( pairs, (const char *)(packet_data + offset), (len - offset) ); - if ( rc < 0 ) + if ( rc <= 0 ) return -1; offset += rc; @@ -2537,280 +306,6 @@ int iscsi_parse_key_value_pairs(iscsi_hashmap *key_value_pairs, const uint8_t *p } /** - * @brief Extracts a string from a key and value pair. - * - * This function calculates the length of the key - * for the hash map function and returns the value - * as string. - * - * @param[in] key_value_pairs The hash map containing the key and value pairs to be extracted. - * @param[in] key The key to retrieve the string value from. - * @param[out] out_value The string value of the key is stored here. - * @retval -1 An error occured during value retrieval. - * 'out value' is unchanged. - * @retval 0 The value of the key has been successfully - * stored in the 'out_value'. - */ -static int iscsi_get_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, uint8_t **out_value) -{ - const uint key_len = (uint) (strlen( (char *) key ) + 1U); - - return iscsi_hashmap_get( key_value_pairs, key, key_len, out_value ); -} - -/** - * @brief Allocates and adds a string value to a key / value hash map pair. - * - * This function allocates memory for a string key - * and its string value. - * - * @param[in] key_value_pairs Pointer to the hash map which should - * contain the added string key and value pair. - * NULL is NOT allowed here, so be careful. - * @param[in] key String containing the key name as string. May - * NOT be NULL, so take caution. - * @param[in] value String containing the value to be stored. - * @return 0 on successful operation, or a negative value on - * error (memory exhaustion). - */ -static int iscsi_add_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, const uint8_t *value) -{ - const uint key_len = (uint) (strlen( (char *) key ) + 1U); - uint8_t *hash_key = iscsi_hashmap_key_create( key, key_len ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_add_key_value_pair: Out of memory allocating key" ); - - return -1; - } - - const uint val_len = (uint) (strlen( (char *) value ) + 1U); - uint8_t *hash_val = (uint8_t *) malloc( ISCSI_ALIGN(val_len, ISCSI_TEXT_VALUE_ALIGN) ); - - if ( hash_val == NULL ) { - logadd( LOG_ERROR, "iscsi_add_key_value_pair: Out of memory allocating string value" ); - - iscsi_hashmap_key_destroy( hash_key ); - - return -1; - } - - memcpy( hash_val, value, val_len ); - - return iscsi_hashmap_put( key_value_pairs, hash_key, key_len, hash_val ); -} - -/** - * @brief Allocates and updates a string value of a key / value hash map pair. - * - * This function allocates memory for a string key - * and its string value.\n - * If the key does not exist, it will be added as - * a new one. - * - * @param[in] key_value_pairs Pointer to the hash map which should - * contain the updated string key and value pair. - * NULL is NOT allowed here, so be careful. - * @param[in] key String containing the key name as string. May - * NOT be NULL, so take caution. - * @param[in] value String containing the value to be stored. - * @return 0 on successful operation, or a negative value on - * error (memory exhaustion). - */ -static int iscsi_update_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, const uint8_t *value) -{ - const uint key_len = (uint) (strlen( (char *) key ) + 1U); - uint8_t *hash_key = iscsi_hashmap_key_create( key, key_len ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_update_key_value_pair: Out of memory allocating key" ); - - return -1; - } - - const uint val_len = (uint) (strlen( (char *) value ) + 1U); - uint8_t *hash_val = (uint8_t *) malloc( ISCSI_ALIGN(val_len, ISCSI_TEXT_VALUE_ALIGN) ); - - if ( hash_val == NULL ) { - logadd( LOG_ERROR, "iscsi_update_key_value_pair: Out of memory allocating string value" ); - - iscsi_hashmap_key_destroy( hash_key ); - - return -1; - } - - memcpy( hash_val, value, val_len ); - - return iscsi_hashmap_put_free( key_value_pairs, hash_key, key_len, hash_val, iscsi_hashmap_key_destroy_value_callback, NULL ); -} - -/** - * @brief Extracts an integer value from a key and value pair. - * - * This function converts a string representation of a - * key and value pair to an integer value. - * - * @param[in] key_value_pairs The hash map containing the key and value pairs to be extracted. - * @param[in] key The key to retrieve the integer value from. - * @param[out] out_value The integer value of the key is stored here - * or 0 in case of an error during string to integer conversion. - * @retval -1 An error occured during value retrieval. - * 'out value' is unchanged. - * @retval 0 The value of the key has been successfully - * stored in the 'out_value'. - */ -static int iscsi_get_int_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, int32_t *out_value) -{ - uint8_t *str_val; - int rc = iscsi_get_key_value_pair( key_value_pairs, key, &str_val ); - - if ( rc == 0 ) - *out_value = (int32_t) atol( (char *) str_val ); - - return rc; -} - -/** - * @brief Allocates and adds an integer value to a key / value hash map pair. - * - * This function allocates memory for a string key - * and its integer representation as string value. - * - * @param[in] key_value_pairs Pointer to the hash map which should - * contain the added integer key and value pair. - * NULL is NOT allowed here, so be careful. - * @param[in] key String containing the key name as string. May - * NOT be NULL, so take caution. - * @param[in] value Integer containing the value to be stored. - * @return 0 on successful operation, or a negative value on - * error (memory exhaustion). - */ -static int iscsi_add_int_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, const int32_t value) -{ - const uint8_t *hash_val = iscsi_sprintf_alloc( "%" PRId32, value ); - - if ( hash_val == NULL ) { - logadd( LOG_ERROR, "iscsi_add_int_key_value_pair: Out of memory allocating integer value." ); - - return -1; - } - - return iscsi_add_key_value_pair( key_value_pairs, key, hash_val ); -} - -/** - * @brief Allocates and updates an integer value of a key / value hash map pair. - * - * This function allocates memory for a string key - * and its integer representation as string value.\n - * If the key does not exist, it will be added as - * a new one. - * - * @param[in] key_value_pairs Pointer to the hash map which should - * contain the updated integer key and value pair. - * NULL is NOT allowed here, so be careful. - * @param[in] key String containing the key name as string. May - * NOT be NULL, so take caution. - * @param[in] value Integer containing the value to be stored. - * @return 0 on successful operation, or a negative value on - * error (memory exhaustion). - */ -static int iscsi_update_int_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, const int32_t value) -{ - uint8_t *hash_val = iscsi_sprintf_alloc( "%" PRId32, value ); - - if ( hash_val == NULL ) { - logadd( LOG_ERROR, "iscsi_update_int_key_value_pair: Out of memory allocating integer value." ); - - return -1; - } - - const int rc = iscsi_update_key_value_pair( key_value_pairs, key, hash_val ); - - free( hash_val ); - - return rc; -} - -/** - * @brief Extracts a boolean value from a key and value pair. - * - * This function converts a string representation of a - * key and value pair to a boolean value. - * - * @param[in] key_value_pairs The hash map containing the key and value pairs to be extracted. - * @param[in] key The key to retrieve the boolean value from. - * @param[out] out_value The boolean value of the key is stored here. - * 'Yes' represents true and any other string results in false. - * @retval -1 An error occured during value retrieval. - * 'out value' is unchanged. - * @retval 0 The value of the key has been successfully - * stored in the 'out_value'. - */ -static int iscsi_get_bool_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, int32_t *out_value) -{ - uint8_t *value; - int rc = iscsi_get_key_value_pair( key_value_pairs, key, &value ); - - if ( rc == 0 ) - *out_value = (strcasecmp( (char *) value, "Yes" ) == 0); - - return rc; -} - -/** - * @brief Allocates and adds an boolean value to a key / value hash map pair. - * - * This function allocates memory for a string key - * and its integer value.\n - * The string representation for true is: Yes\n - * The string representation for false is: No - * - * @param[in] key_value_pairs Pointer to the hash map which should - * contain the added boolean key and value pair. - * NULL is NOT allowed here, so be careful. - * @param[in] key String containing the key name as string. May - * NOT be NULL, so take caution. - * @param[in] value Boolean containing the value to be stored - * as string. - * @return 0 on successful operation, or a negative value on - * error (memory exhaustion). - */ -static int iscsi_add_bool_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, const int value) -{ - const uint8_t *hash_val = (uint8_t *) ((value != 0) ? "Yes" : "No"); - - return iscsi_add_key_value_pair( key_value_pairs, key, hash_val ); -} - -/** - * @brief Allocates and updates an boolean value of a key / value hash map pair. - * - * This function allocates memory for a string key - * and its integer value.\n - * The string representation for true is: Yes\n - * The string representation for false is: No\n - * If the key does not exist, it will be added as - * a new one. - * - * @param[in] key_value_pairs Pointer to the hash map which should - * contain the updated boolean key and value pair. - * NULL is NOT allowed here, so be careful. - * @param[in] key String containing the key name as string. May - * NOT be NULL, so take caution. - * @param[in] value Boolean containing the value to be stored - * as string. - * @return 0 on successful operation, or a negative value on - * error (memory exhaustion). - */ -static int iscsi_update_bool_key_value_pair(iscsi_hashmap *key_value_pairs, const uint8_t *key, const int value) -{ - const uint8_t *hash_val = (uint8_t *) ((value != 0) ? "Yes" : "No"); - - return iscsi_update_key_value_pair( key_value_pairs, key, hash_val ); -} - -/** * @brief Allocates and initializes an iSCSI task structure. * * This function also initializes the underlying @@ -2822,18 +317,12 @@ static int iscsi_update_bool_key_value_pair(iscsi_hashmap *key_value_pairs, cons * @param[in] conn Pointer to iSCSI connection to associate * the task with. May NOT be NULL, so take * caution. - * @param[in] parent Pointer to parent iSCSI task to copy - * over SCSI task data from. - * @param[in] callback Callback function to be invoked - * after data transfer has been completed and - * may be NULL in case no further action is - * required. * @return Pointer to iSCSI task structure or NULL * in case of an error (memory exhaustion). */ -iscsi_task *iscsi_task_create(iscsi_connection *conn, iscsi_task *parent, iscsi_scsi_task_xfer_complete_callback callback) +static iscsi_task *iscsi_task_create(iscsi_connection *conn) { - iscsi_task *task = (iscsi_task *) malloc( sizeof(struct iscsi_task) ); + iscsi_task *task = malloc( sizeof(struct iscsi_task) ); if ( task == NULL ) { logadd( LOG_ERROR, "iscsi_task_create: Out of memory while allocating iSCSI task" ); @@ -2841,14 +330,7 @@ iscsi_task *iscsi_task_create(iscsi_connection *conn, iscsi_task *parent, iscsi_ return NULL; } - task->node.succ = NULL; - task->node.pred = NULL; - task->parent = parent; - task->sub_tasks.head = NULL; - task->sub_tasks.tail = NULL; - task->sub_tasks.pred = NULL; task->conn = conn; - task->pdu = NULL; task->pos = 0UL; task->len = 0UL; task->id = 0ULL; @@ -2859,77 +341,14 @@ iscsi_task *iscsi_task_create(iscsi_connection *conn, iscsi_task *parent, iscsi_ task->des_data_xfer_pos = 0UL; task->des_data_xfer_len = 0UL; task->data_sn = 0UL; - task->scsi_data_out_cnt = 0UL; - task->r2t_len = 0UL; - task->r2t_sn = 0UL; - task->r2t_next_exp_pos = 0UL; - task->r2t_data_sn = 0UL; - task->r2t_sn_ack = 0UL; - task->r2t_outstanding = 0UL; - - conn->task_cnt++; - - iscsi_scsi_task_create( &task->scsi_task, callback, iscsi_task_destroy_callback ); - - if ( parent != NULL ) { - parent->scsi_task.ref++; - task->init_task_tag = parent->init_task_tag; - task->lun_id = parent->lun_id; - - task->scsi_task.flags = parent->scsi_task.flags; - task->scsi_task.xfer_len = parent->scsi_task.xfer_len; - task->scsi_task.lun = parent->scsi_task.lun; - task->scsi_task.cdb = parent->scsi_task.cdb; - task->scsi_task.target_port = parent->scsi_task.target_port; - task->scsi_task.init_port = parent->scsi_task.init_port; - - if ( (task->scsi_task.flags & ISCSI_SCSI_TASK_FLAGS_XFER_READ) != 0 ) - conn->scsi_data_in_cnt++; - } + iscsi_scsi_task_create( &task->scsi_task ); + task->scsi_task.connection = conn; return task; } /** - * @brief Deallocates all resources of the iSCSI task of an iSCSI SCSI task. - * - * This callback function is called when the - * iSCSI SCSI task itself is about to be - * destroyed in order to free the associated - * iSCSI task and PDU. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to deallocate - * its iSCSI task. May NOT be NULL, so ba - * careful. - */ -void iscsi_task_destroy_callback(iscsi_scsi_task *scsi_task) -{ - if ( scsi_task != NULL ) { - iscsi_task *task = ISCSI_CONTAINER(iscsi_task, scsi_task, scsi_task); - - if ( task->parent != NULL ) { - if ( (task->scsi_task.flags & ISCSI_SCSI_TASK_FLAGS_XFER_READ) != 0 ) - task->conn->scsi_data_in_cnt--; - - iscsi_scsi_task_destroy( &task->parent->scsi_task ); - - task->parent = NULL; - } - - if ( task->pdu != NULL ) { - iscsi_connection_pdu_destroy( task->pdu ); - - task->pdu = NULL; - } - - task->conn->task_cnt--; - - free( task ); - } -} - -/** * @brief Deallocates resources acquired by iscsi_task_create. * * This function also frees the embedded SCSI task. @@ -2937,361 +356,13 @@ void iscsi_task_destroy_callback(iscsi_scsi_task *scsi_task) * @param[in] task Pointer to iSCSI task to deallocate. If * set to NULL, this function does nothing. */ -void iscsi_task_destroy(iscsi_task *task) -{ - if ( task != NULL ) - iscsi_scsi_task_destroy( &task->scsi_task ); -} - -/** - * @brief Enqueues an iSCSI task. - * - * This function adds an iSCSI task to a - * SCSI queue. - * - * @param[in] conn Pointer to iSCSI connection to enqueue - * the task to and may NOT be NULL, so be - * careful. - * @param[in] task Pointer to iSCSI task to enqueue to the - * associated device. NULL is not allowed - * here, take caution. - */ -void iscsi_task_queue(iscsi_connection *conn, iscsi_task *task) +static void iscsi_task_destroy(iscsi_task *task) { - task->flags |= ISCSI_TASK_FLAGS_QUEUED; - - iscsi_device_scsi_task_queue( conn->device, &task->scsi_task ); -} - -/** - * @brief Searches an iSCSI task by Target Transfer Tag (TTT). - * - * This function searches for an iSCSI task by - * iterating through the iSCSI connection active - * Ready To Transfer tasks doubly linked list. - * - * @param[in] conn Pointer to iSCSI connection to - * search in the active Ready To Transfer tasks - * doubly linked list and may NOT be NULL, so - * be careful. - * @param[in] target_xfer_tag Target Transfer Tag (TTT) - * to be searched for. - * @return Pointer to found iSCSI task or NULL in - * case no iSCSI task has a matching Target - * Transfer Tag (TTT). - */ -static iscsi_task *iscsi_task_find(iscsi_connection *conn, const uint32_t target_xfer_tag) -{ - iscsi_task *task; - - iscsi_list_foreach_node ( &conn->r2t_tasks_active, task ) { - if ( task->target_xfer_tag == target_xfer_tag ) - return task; - } - - return NULL; -} - -/** - * @brief Removes all iSCSI SCSI sub tasks of a primary task which completed a read data transfer in case data sequence is in order. - * - * This function removes all sub tasks of an iSCSI - * primary task which have finished their transfers - * when the data sequence is in order. - * - * @param[in] conn Pointer to iSCSI connection of which - * the data transfer has been finished and - * may NOT be NULL, so be careful. - * @param[in] primary_task Pointer to iSCSI primary task - * of which to remove all sub tasks which have - * finished the data transfer. NULL is NOT allowed - * here, so take caution. - */ -static void iscsi_task_xfer_complete_process_read_sub_tasks(iscsi_connection *conn, iscsi_task *primary_task) -{ - iscsi_task *sub_task; - iscsi_task *tmp; - - iscsi_list_foreach_safe_node ( &primary_task->sub_tasks, sub_task, tmp ) { - if ( primary_task->des_data_xfer_pos != sub_task->scsi_task.pos ) - break; - - iscsi_list_remove( &sub_task->node ); - - primary_task->des_data_xfer_pos += sub_task->scsi_task.len; - - if ( primary_task->des_data_xfer_pos == primary_task->scsi_task.xfer_len ) - iscsi_task_destroy( primary_task ); - - iscsi_task_response( conn, sub_task ); - iscsi_task_destroy( sub_task ); - } -} - -/** - * @brief Processes an iSCSI SCSI task which completed a read data transfer. - * - * This function post-processes a task upon - * finish of a read data transfer. - * - * @param[in] conn Pointer to iSCSI connection of which - * the data transfer has been finished and - * may NOT be NULL, so be careful. - * @param[in] task Pointer to iSCSI task which finished - * the data transfer. NULL is NOT allowed - * here, so take caution. - * @param[in] primary_task Pointer to iSCSI primary task - * which finished the data transfer which - * may NOT be NULL, so be careful. - */ -void iscsi_task_xfer_complete_process_read(iscsi_connection *conn, iscsi_task *task, iscsi_task *primary_task) -{ - if ( task->scsi_task.status != ISCSI_SCSI_STATUS_GOOD ) { - if ( primary_task->scsi_task.status == ISCSI_SCSI_STATUS_GOOD ) { - iscsi_task *sub_task; - - iscsi_list_foreach_node ( &primary_task->sub_tasks, sub_task ) { - iscsi_scsi_task_status_copy( &sub_task->scsi_task, &task->scsi_task ); - } - - iscsi_scsi_task_status_copy( &primary_task->scsi_task, &task->scsi_task ); - } - } else if ( primary_task->scsi_task.status != ISCSI_SCSI_STATUS_GOOD ) { - iscsi_scsi_task_status_copy( &task->scsi_task, &primary_task->scsi_task ); - } - - if ( task == primary_task ) { - primary_task->des_data_xfer_pos = task->scsi_task.len; - - iscsi_task_response( conn, task ); - iscsi_task_destroy( task ); - } else if ( (conn->session->flags & ISCSI_SESSION_FLAGS_DATA_SEQ_IN_ORDER) == 0 ) { - primary_task->des_data_xfer_pos += task->scsi_task.len; - - if ( primary_task->des_data_xfer_pos == primary_task->scsi_task.xfer_len ) - iscsi_task_destroy(primary_task ); - - iscsi_task_response( conn, task ); - iscsi_task_destroy( task ); - } else if ( task->scsi_task.pos != primary_task->des_data_xfer_pos ) { - iscsi_task *sub_task; - - iscsi_list_foreach_node ( &primary_task->sub_tasks, sub_task ) { - if ( task->scsi_task.pos < sub_task->scsi_task.pos ) { - iscsi_list_insert( &primary_task->sub_tasks, &sub_task->node, task->node.pred ); - - return; - } - } - - iscsi_list_enqueue( &primary_task->sub_tasks, &task->node ); - } else { - iscsi_list_push( &primary_task->sub_tasks, &task->node ); - - iscsi_task_xfer_complete_process_read_sub_tasks( conn, primary_task ); - } -} - -/** - * @brief Adds an iSCSI transfer task to either pending (if maximum is exceeded) or active tasks doubly linked list. - * - * This function also sends Ready To Transfer - * (R2T) packet data to the initiator. - * - * @param[in] conn Pointer to iSCSI connection to add the - * transfer task to. May NOT be NULL, so be - * careful. - * @param[in] task Pointer to iSCSI task to add to - * active or pending doubly linked list. - * NULL is NOT allowed here, take caution. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -static int iscsi_task_xfer_add(iscsi_connection *conn, iscsi_task *task) -{ - const uint32_t xfer_len = task->scsi_task.xfer_len; - uint32_t ds_len = task->pdu->ds_len; - const uint32_t seg_len = ISCSI_DEFAULT_MAX_RECV_DS_LEN; - const uint32_t data_out_req = (uint32_t) (iscsi_is_pow2( seg_len ) ? (((xfer_len - ds_len - 1UL) >> iscsi_get_log2_of_pow2( seg_len )) + 1UL) : (((xfer_len - ds_len - 1UL) / seg_len) + 1UL)); - - task->scsi_data_out_cnt = data_out_req; - - if ( conn->r2t_pending >= ISCSI_DEFAULT_MAX_R2T_PER_CONNECTION ) { - iscsi_list_enqueue( &conn->r2t_tasks_queue, &task->node ); - - return ISCSI_CONNECT_PDU_READ_OK; - } - - conn->scsi_data_out_cnt += data_out_req; - conn->r2t_pending++; - - task->r2t_next_exp_pos = ds_len; - task->r2t_len = 0UL; - task->r2t_sn = 0UL; - - if ( ++conn->target_xfer_tag == 0xFFFFFFFFUL ) - conn->target_xfer_tag = 0UL; - - task->target_xfer_tag = conn->target_xfer_tag; - - const uint32_t max_burst_len = conn->session->max_burst_len; - - while ( ds_len != xfer_len ) { - uint32_t len = (xfer_len - ds_len); - - if ( len > max_burst_len ) - len = max_burst_len; - - const int rc = iscsi_r2t_send( conn, task, &task->r2t_sn, ds_len, len, task->target_xfer_tag ); - - if ( rc < 0 ) - return rc; - - ds_len += len; - - task->r2t_next_exp_pos = ds_len; - - if ( conn->session->max_outstanding_r2t == ++task->r2t_outstanding ) - break; - } - - iscsi_list_enqueue( &conn->r2t_tasks_active, &task->node ); - - task->flags |= ISCSI_TASK_FLAGS_R2T_ACTIVE; - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Starts queued iSCSI Ready To Transfer (R2T) tasks by moving them from queued doubly linked list to active doubly linked list. - * - * This function iterates through all enqueued - * transfer tasks of an ISCSI connection and moves - * them into the active transfer tasks doubly - * linked list until the maximum number of active - * transfer tasks has been reached. - * - * @param[in] conn Pointer to iSCSI connection from where to - * move the enqueued iSCSI tasks to the active task - * doubly linked list. May NOT be NULL, so be - * careful. - */ -static void iscsi_task_xfer_queued_tasks_start(iscsi_connection *conn) -{ - iscsi_task *task; - iscsi_task *tmp; - - iscsi_list_foreach_safe_node ( &conn->r2t_tasks_queue, task, tmp ) { - if ( conn->r2t_pending >= ISCSI_DEFAULT_MAX_R2T_PER_CONNECTION ) - return; - - iscsi_list_remove( &task->node ); - iscsi_task_xfer_add( conn, task ); - } -} - -/** - * @brief Deletes an iSCSI task from the active Ready To Transfer (R2T) doubly linked list by Target Transfer Tag (TTT). - * - * This function traverses through an iSCSI task's - * active Ready To Transfer (R2T) doubly linked - * list in order to find the Target Transfer Tag - * (TTT) to be deleted. - * - * @param[in] conn Pointer to iSCSI connection to - * search in the active Ready To Transfer - * (R2T) doubly linked list. - * @param[in] target_xfer_tag Target Transfer Tag (TTT) to - * delete the ISCSI task of. - * @retval true The iSCSI task has been found and - * deleted successfully. - * @retval false The iSCSI task does NOT exist and - * therefore could NOT be deleted. - */ -bool iscsi_task_xfer_del(iscsi_connection *conn, const uint32_t target_xfer_tag) -{ - iscsi_task *task; - iscsi_task *tmp; - - iscsi_list_foreach_safe_node ( &conn->r2t_tasks_active, task, tmp ) { - if ( task->target_xfer_tag != target_xfer_tag ) - continue; - - conn->scsi_data_out_cnt -= task->scsi_data_out_cnt; - conn->r2t_pending--; - - iscsi_list_remove( &task->node ); - - task->flags &= ~ISCSI_TASK_FLAGS_R2T_ACTIVE; - - iscsi_task_destroy( task ); - iscsi_task_xfer_queued_tasks_start( conn ); - - return true; - } - - return false; -} - -/** - * @brief Processes an iSCSI SCSI task which completed a non-read data transfer. - * - * This function post-processes a task upon - * finish of a non-read data transfer. - * - * @param[in] conn Pointer to iSCSI connection of which - * the data transfer has been finished and - * may NOT be NULL, so be careful. - * @param[in] task Pointer to iSCSI task which finished - * the data transfer. NULL is NOT allowed - * here, so take caution. - * @param[in] primary_task Pointer to iSCSI primary task - * which finished the data transfer which - * may NOT be NULL, so be careful. - */ -void iscsi_task_xfer_complete_process_other(iscsi_connection *conn, iscsi_task *task, iscsi_task *primary_task) -{ - primary_task->des_data_xfer_pos += task->scsi_task.len; - - if ( task == primary_task ) { - iscsi_task_response( conn, task ); - iscsi_task_destroy( task ); - + if ( task == NULL ) return; - } - if ( task->scsi_task.status == ISCSI_SCSI_STATUS_GOOD ) - primary_task->scsi_task.xfer_pos += task->scsi_task.xfer_pos; - else if ( primary_task->scsi_task.status == ISCSI_SCSI_STATUS_GOOD ) - iscsi_scsi_task_status_copy( &primary_task->scsi_task, &task->scsi_task ); - - if ( primary_task->des_data_xfer_pos == primary_task->scsi_task.xfer_len ) { - if ( (primary_task->flags & ISCSI_TASK_FLAGS_R2T_ACTIVE) != 0 ) { - iscsi_task_response( conn, primary_task ); - iscsi_task_xfer_del( conn, primary_task->target_xfer_tag ); - } else { - iscsi_task_response( conn, task ); - } - } - - iscsi_task_destroy( task ); -} - -/** - * @brief Callback function after iSCSI SCSI Data In response has been sent. - * - * This function is invoked after the iSCSI - * SCSI Data In response has been sent to - * the client via TCP/IP. - * - * @param[in] user_data Pointer to iSCSI connection which - * was used for sending the response. - */ -static void iscsi_connection_pdu_scsi_data_in_complete(uint8_t *user_data) -{ - iscsi_connection *conn = (iscsi_connection *) user_data; - - iscsi_connection_handle_scsi_data_in_queued_tasks( conn ); + free( task->scsi_task.buf ); + free( task ); } /** @@ -3315,9 +386,9 @@ static void iscsi_connection_pdu_scsi_data_in_complete(uint8_t *user_data) * @return Next Data Sequence Number (DataSN) on success, * the same DataSN as passed on error. */ -static uint32_t iscsi_scsi_data_in_send(iscsi_connection *conn, iscsi_task *task, const uint32_t pos, const uint32_t len, const uint32_t res_cnt, const uint32_t data_sn, const int8_t flags) +static uint32_t iscsi_scsi_data_in_send(iscsi_connection *conn, iscsi_task *task, const uint32_t pos, const uint32_t len, const uint32_t res_cnt, const uint32_t data_sn, const int8_t flags, bool immediate) { - iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, len, conn->data_digest ); + iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, len ); if ( response_pdu == NULL ) { logadd( LOG_ERROR, "iscsi_scsi_data_in_send: Out of memory while allocating iSCSI SCSI Data In response PDU" ); @@ -3326,7 +397,6 @@ static uint32_t iscsi_scsi_data_in_send(iscsi_connection *conn, iscsi_task *task } response_pdu->task = task; - task->scsi_task.ref++; iscsi_scsi_data_in_response_packet *scsi_data_in_pkt = (iscsi_scsi_data_in_response_packet *) response_pdu->bhs_pkt; @@ -3334,14 +404,13 @@ static uint32_t iscsi_scsi_data_in_send(iscsi_connection *conn, iscsi_task *task scsi_data_in_pkt->flags = (flags & ~(ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_RES_UNDERFLOW | ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_RES_OVERFLOW)); scsi_data_in_pkt->reserved = 0U; - iscsi_task *primary_task = ((task->parent != NULL) ? task->parent : task); - if ( (flags & ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_STATUS) != 0 ) { if ( (flags & ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_FINAL) != 0 ) { scsi_data_in_pkt->flags |= (flags & (ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_RES_UNDERFLOW | ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_RES_OVERFLOW)); - if ( (primary_task->pdu->bhs_pkt->opcode & ISCSI_OPCODE_FLAGS_IMMEDIATE) == 0 ) + if ( !immediate ) { conn->session->max_cmd_sn++; + } iscsi_put_be32( (uint8_t *) &scsi_data_in_pkt->res_cnt, res_cnt ); } else { @@ -3364,15 +433,12 @@ static uint32_t iscsi_scsi_data_in_send(iscsi_connection *conn, iscsi_task *task iscsi_put_be32( (uint8_t *) &scsi_data_in_pkt->max_cmd_sn, conn->session->max_cmd_sn ); iscsi_put_be32( (uint8_t *) &scsi_data_in_pkt->data_sn, data_sn ); - if ( conn->session->err_recovery_level > 0UL ) - primary_task->data_sn = data_sn; - const uint32_t offset = (task->scsi_task.pos + pos); iscsi_put_be32( (uint8_t *) &scsi_data_in_pkt->buf_offset, offset ); memcpy( response_pdu->ds_cmd_data, (task->scsi_task.buf + pos), len ); - iscsi_connection_pdu_write( conn, response_pdu, iscsi_connection_pdu_scsi_data_in_complete, (uint8_t *) conn ); + iscsi_connection_pdu_write( conn, response_pdu ); return (data_sn + 1UL); } @@ -3390,17 +456,18 @@ static uint32_t iscsi_scsi_data_in_send(iscsi_connection *conn, iscsi_task *task * @param[in] task Pointer to iSCSI task for handling * the incoming data. NULL is NOT allowed here, * take caution. + * @param immediate * @return 0 on successful incoming transfer handling, * a negative error code otherwise. */ -static int iscsi_task_xfer_scsi_data_in(iscsi_connection *conn, iscsi_task *task) +static int iscsi_task_xfer_scsi_data_in(iscsi_connection *conn, iscsi_task *task, bool immediate) { if ( task->scsi_task.status != ISCSI_SCSI_STATUS_GOOD ) return 0; const uint32_t pos = task->scsi_task.xfer_pos; uint32_t xfer_len = task->scsi_task.len; - const uint32_t seg_len = conn->max_recv_ds_len; + const uint32_t seg_len = conn->session->opts.MaxRecvDataSegmentLength; uint32_t res_cnt = 0UL; int8_t flags = 0; @@ -3413,11 +480,10 @@ static int iscsi_task_xfer_scsi_data_in(iscsi_connection *conn, iscsi_task *task flags |= ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_RES_OVERFLOW; } - iscsi_task *primary_task = ((task->parent != NULL) ? task->parent : task); - uint32_t data_sn = primary_task->data_sn; + uint32_t data_sn = task->data_sn; uint32_t max_burst_offset = 0UL; - const uint32_t max_burst_len = conn->session->max_burst_len; - const uint32_t data_in_seq_count = (uint32_t) (iscsi_is_pow2( max_burst_len ) ? (((xfer_len - 1UL) >> iscsi_get_log2_of_pow2( max_burst_len )) + 1UL) : (((xfer_len - 1UL) / max_burst_len) + 1UL)); + const uint32_t max_burst_len = conn->session->opts.MaxBurstLength; + const uint32_t data_in_seq_count = ((xfer_len - 1UL) / max_burst_len) + 1UL; int8_t status = 0; for ( uint32_t i = 0UL; i < data_in_seq_count; i++ ) { @@ -3437,22 +503,19 @@ static int iscsi_task_xfer_scsi_data_in(iscsi_connection *conn, iscsi_task *task if ( (offset + len) == seq_end ) { flags |= (int8_t) ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_FINAL; - if ( (task->scsi_task.sense_data_len == 0U) && ((offset + len) == xfer_len) && (primary_task->des_data_xfer_pos == primary_task->scsi_task.xfer_len) ) { + if ( (task->scsi_task.sense_data_len == 0U) && ((offset + len) == xfer_len) && (task->des_data_xfer_pos == task->scsi_task.xfer_len) ) { flags |= (int8_t) ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_STATUS; status |= flags; } } - data_sn = iscsi_scsi_data_in_send( conn, task, offset, len, res_cnt, data_sn, flags ); + data_sn = iscsi_scsi_data_in_send( conn, task, offset, len, res_cnt, data_sn, flags, immediate ); } max_burst_offset += max_burst_len; } - if ( primary_task != task ) - primary_task->scsi_task.xfer_pos += task->scsi_task.xfer_pos; - - primary_task->data_sn = data_sn; + task->data_sn = data_sn; return (status & ISCSI_SCSI_DATA_IN_RESPONSE_FLAGS_STATUS); } @@ -3470,22 +533,20 @@ static int iscsi_task_xfer_scsi_data_in(iscsi_connection *conn, iscsi_task *task * response PDU from. NULL is NOT allowed * here, take caution. */ -void iscsi_task_response(iscsi_connection *conn, iscsi_task *task) +static void iscsi_task_response(iscsi_connection *conn, iscsi_task *task, iscsi_pdu *pdu) { - iscsi_task *primary_task = ((task->parent != NULL) ? task->parent : task); - iscsi_pdu *pdu = primary_task->pdu; iscsi_scsi_cmd_packet *scsi_cmd_pkt = (iscsi_scsi_cmd_packet *) pdu->bhs_pkt; - const uint32_t xfer_len = primary_task->scsi_task.xfer_len; + const uint32_t xfer_len = task->scsi_task.xfer_len; if ( (scsi_cmd_pkt->flags_task & ISCSI_SCSI_CMD_FLAGS_TASK_READ) != 0 ) { - const int rc = iscsi_task_xfer_scsi_data_in( conn, task ); + const int rc = iscsi_task_xfer_scsi_data_in( conn, task, (pdu->bhs_pkt->opcode & ISCSI_OPCODE_FLAGS_IMMEDIATE) != 0 ); - if ( (rc > 0) || (primary_task->des_data_xfer_pos != primary_task->scsi_task.xfer_len) ) + if ( (rc > 0) || (task->des_data_xfer_pos != task->scsi_task.xfer_len) ) return; } - const uint32_t ds_len = ((task->scsi_task.sense_data_len != 0U) ? (task->scsi_task.sense_data_len + offsetof(struct iscsi_scsi_ds_cmd_data, sense_data)) : 0UL); - iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, ds_len, conn->data_digest ); + const uint32_t ds_len = (task->scsi_task.sense_data_len != 0U) ? (task->scsi_task.sense_data_len + offsetof(struct iscsi_scsi_ds_cmd_data, sense_data)) : 0UL; + iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, ds_len ); if ( response_pdu == NULL ) { logadd( LOG_ERROR, "iscsi_task_response: Out of memory while allocating iSCSI SCSI response PDU" ); @@ -3507,13 +568,12 @@ void iscsi_task_response(iscsi_connection *conn, iscsi_task *task) } response_pdu->task = task; - task->scsi_task.ref++; scsi_response_pkt->opcode = ISCSI_OPCODE_SERVER_SCSI_RESPONSE; scsi_response_pkt->flags = -0x80; scsi_response_pkt->response = ISCSI_SCSI_RESPONSE_CODE_OK; - const uint32_t pos = primary_task->scsi_task.xfer_pos; + const uint32_t pos = task->scsi_task.xfer_pos; if ( (xfer_len != 0UL) && (task->scsi_task.status == ISCSI_SCSI_STATUS_GOOD) ) { if ( pos < xfer_len ) { @@ -3547,355 +607,28 @@ void iscsi_task_response(iscsi_connection *conn, iscsi_task *task) scsi_response_pkt->exp_data_sn = 0UL; scsi_response_pkt->bidi_read_res_cnt = 0UL; - iscsi_connection_pdu_write( conn, response_pdu, NULL, NULL ); + iscsi_connection_pdu_write( conn, response_pdu ); } /** - * @brief Creates and initializes an iSCSI portal group. - * - * Specified tag and flags are used for portal group - * initialization. - * @param[in] tag Tag to associate with the portal group. - * @param[in] flags Flags to set for the portal group. - * @return Pointer to allocated and initialized portal group - * or NULL in case of memory - */ -iscsi_portal_group *iscsi_portal_group_create(const uint64_t tag, const int flags) -{ - iscsi_portal_group *portal_group = (iscsi_portal_group *) malloc( sizeof(struct iscsi_portal_group) ); - - if ( portal_group == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_group_create: Out of memory allocating iSCSI portal group structure" ); - - return NULL; - } - - portal_group->portals = iscsi_hashmap_create( 0U ); - - if ( portal_group->portals == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_group_create: Out of memory allocating iSCSI portal hash map" ); - - free( portal_group ); - - return NULL; - } - - portal_group->ref_count = 0; - portal_group->tag = tag; - portal_group->flags = flags; - portal_group->chap_group = 0L; - - return portal_group; -} - -/** - * @brief iSCSI portal group destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * portal group stored in the hash map managing all - * iSCSI portal groups. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_portal_group_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_portal_group_destroy( (iscsi_portal_group *) value ); - - return 0; -} - -/** - * @brief Deallocates resources acquired by iscsi_portal_group_create. - * - * This function frees the associated hash map containing the - * poptals and the structure itself. - * - * @param[in] portal_group Pointer to iSCSI portal group to deallocate. - * May be NULL in which case this function does nothing. - */ -void iscsi_portal_group_destroy(iscsi_portal_group *portal_group) -{ - if ( portal_group != NULL ) { - if ( portal_group->portals != NULL ) { - iscsi_hashmap_iterate( portal_group->portals, iscsi_portal_destroy_callback, NULL ); - iscsi_hashmap_destroy( portal_group->portals ); - - portal_group->portals = NULL; - } - - free( portal_group ); - } -} - -/** - * @brief Adds an iSCSI portal to the iSCSI portal group hash map. - * - * This function allocates host:port of iSCSI portal for use - * as key and sets the portal group in the portal. - * - * @param[in] portal_group iSCSI portal group to add portal to. May NOT be NULL, - * so take caution. - * @param[in] portal iSCSI portal to add to portal group. NULL is NOT - * allowed here, so be careful. - * @retval -1 An error occured during adding the portal, - * usually caused by memory exhaustion - * @retval 0 The portal has been added successfully to the - * portal group. - */ -int iscsi_portal_group_add_portal(iscsi_portal_group *portal_group, iscsi_portal *portal) -{ - uint8_t *tmp_buf = iscsi_sprintf_alloc( "%s:%s", portal->host, portal->port ); - - if ( tmp_buf == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_group_add_portal: Out of memory allocating temporarily key buffer for iSCSI portal" ); - - return -1; - } - - const uint key_len = (uint) (strlen( (char *) tmp_buf ) + 1U); - uint8_t *key = iscsi_hashmap_key_create( tmp_buf, key_len ); - - free( tmp_buf ); - - if ( key == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_group_add_portal: Out of memory allocating key for iSCSI portal" ); - - return -1; - } - - int rc = iscsi_hashmap_put( portal_group->portals, key, key_len, (uint8_t *) portal ); - - if ( rc < 0 ) { - logadd( LOG_ERROR, "iscsi_portal_group_add_portal: Adding portal to hash map containing iSCSI portal group failed" ); - - iscsi_hashmap_key_destroy( key ); - - return rc; - } - - portal->group = portal_group; - - return 0; -} - -/** - * @brief Removes an iSCSI portal from the iSCSI portal group hash map. - * - * This function deallocates the hash key used - * for storing the portal in the portal group - * as well. - * - * @param[in] portal_group iSCSI portal group to remove portal from. May - * NOT be NULL, so take caution. - * @param[in] portal iSCSI portal to remove from the portal group. - * NULL is NOT allowed here, so be careful. - */ -void iscsi_portal_group_del_portal(iscsi_portal_group *portal_group, iscsi_portal *portal) -{ - uint8_t *tmp_buf = iscsi_sprintf_alloc( "%s:%s", portal->host, portal->port ); - - if ( tmp_buf == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_group_del_portal: Out of memory allocating temporarily key buffer for iSCSI portal" ); - - return; - } - - const uint key_len = (uint) (strlen( (char *) tmp_buf ) + 1U); - uint8_t *key = iscsi_hashmap_key_create( tmp_buf, key_len ); - - free( tmp_buf ); - - if ( key == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_group_del_portal: Out of memory allocating key for iSCSI portal" ); - - return; - } - - if ( iscsi_hashmap_contains( portal_group->portals, key, key_len ) ) { - portal->group = NULL; - - iscsi_hashmap_remove_free( portal_group->portals, key, key_len, iscsi_hashmap_key_destroy_callback, NULL ); - } - - iscsi_hashmap_key_destroy( key ); -} - -/** - * @brief Allocates and initializes an iSCSI portal structure. - * - * This function makes a copy of the passed host / IP address - * and port, but does NOT initialize the socket. - * - * @param[in] host Host / IP address of the portal. - * @param[in] port Port of the portal. - * @return Pointer to iSCSI portal structure or NULL - * in case of an error (memory exhausted). - */ -iscsi_portal *iscsi_portal_create(const uint8_t *host, const uint8_t *port) -{ - iscsi_portal *portal = (iscsi_portal *) malloc( sizeof(struct iscsi_portal) ); - - if ( portal == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_create: Out of memory allocating iSCSI portal structure" ); - - return NULL; - } - - portal->group = NULL; - - const uint host_len = (uint) (strlen( (char *) host ) + 1U); - - portal->host = (uint8_t *) malloc( host_len ); - - if ( portal->host == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_create: Out of memory allocating iSCSI portal host name" ); - - return NULL; - } - - memcpy( portal->host, host, host_len ); - - const uint port_len = (uint) (strlen( (char *) port ) + 1U); - - portal->port = (uint8_t *) malloc( port_len ); - - if ( portal->port == NULL ) { - logadd( LOG_ERROR, "iscsi_portal_create: Out of memory allocating iSCSI portal port" ); - - return NULL; - } - - memcpy( portal->port, port, port_len ); - - portal->sock = -1; - - return portal; -} - -/** - * @brief iSCSI portal destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * portal stored in the iSCSI portal group hash map. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_portal_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_portal_destroy( (iscsi_portal *) value ); - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** - * @brief Deallocates all resources acquired by iscsi_portal_create. - * - * This function frees the memory acquired for host / IP address - * and port but does NOT remove it from the portal group hash map. - * - * @param[in] portal Pointer to iSCSI portal to be deallocated, - * which may be NULL in which case the function does nothing. - */ -void iscsi_portal_destroy(iscsi_portal *portal) -{ - if ( portal != NULL ) { - if ( portal->port != NULL ) { - free( portal->port ); - - portal->port = NULL; - } - - if ( portal->host != NULL ) { - free( portal->host ); - - portal->host = NULL; - } - - free( portal ); - } -} - -/** - * @brief Allocates and initializes a SCSI task. - * - * THis function assocates the callback - * functions to the SCSI task and sets - * the reference count to 1. + * @brief Initializes a SCSI task. * * @param[in] scsi_task Pointer to SCSI task. This * may NOT be NULL, so be careful. - * @param[in] xfer_complete_callback Pointer to transfer completed callback - * function. - * @param[in] destroy_callback Pointer to SCSI task destruction - * callback function. */ -void iscsi_scsi_task_create(iscsi_scsi_task *scsi_task, iscsi_scsi_task_xfer_complete_callback xfer_complete_callback, iscsi_scsi_task_destroy_callback destroy_callback) +static void iscsi_scsi_task_create(iscsi_scsi_task *scsi_task) { - scsi_task->node.succ = NULL; - scsi_task->node.pred = NULL; - scsi_task->lun = NULL; - scsi_task->target_port = NULL; - scsi_task->init_port = NULL; scsi_task->cdb = NULL; scsi_task->sense_data = NULL; - scsi_task->xfer_complete_callback = xfer_complete_callback; - scsi_task->destroy_callback = destroy_callback; - scsi_task->io_complete_callback = NULL; - scsi_task->io_wait.image = NULL; - scsi_task->io_wait.callback = NULL; - scsi_task->io_wait.user_data = NULL; scsi_task->buf = NULL; scsi_task->pos = 0UL; scsi_task->len = 0UL; scsi_task->id = 0ULL; scsi_task->flags = 0; - scsi_task->ref = 1UL; scsi_task->xfer_pos = 0UL; scsi_task->xfer_len = 0UL; scsi_task->sense_data_len = 0U; scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - scsi_task->task_mgmt_func = ISCSI_TASK_MGMT_FUNC_REQ_FUNC_ABORT_TASK; - scsi_task->task_mgmt_response = ISCSI_TASK_MGMT_FUNC_RESPONSE_FUNC_COMPLETE; -} - -/** - * @brief Deallocates all resources acquired iscsi_scsi_task_create. - * - * This function also calls the task destruction - * callback function if the reference count - * becomes zero. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to deallocate. - * This may be NULL in which case nothing - * happens. - */ -void iscsi_scsi_task_destroy(iscsi_scsi_task *scsi_task) -{ - if ( (scsi_task != NULL) && (--scsi_task->ref == 0UL) ) { - if ( scsi_task->buf != NULL ) { - if ( (scsi_task->flags & ISCSI_SCSI_TASK_FLAGS_XFER_WRITE) == 0 ) - free( scsi_task->buf ); - - scsi_task->buf = NULL; - } - - scsi_task->destroy_callback( scsi_task ); - } } /** @@ -3907,20 +640,17 @@ void iscsi_scsi_task_destroy(iscsi_scsi_task *scsi_task) * @param[in] scsi_task Pointer to iSCSI SCSI task which finished * the data transfer and may NOT be NULL, * so be careful. + * @param pdu */ -void iscsi_scsi_task_xfer_complete(iscsi_scsi_task *scsi_task) +static void iscsi_scsi_task_xfer_complete(iscsi_scsi_task *scsi_task, iscsi_pdu *pdu) { - iscsi_task *task = ISCSI_CONTAINER(iscsi_task, scsi_task, scsi_task); - - task->flags &= ~ISCSI_TASK_FLAGS_QUEUED; - - iscsi_task *primary_task = ((task->parent != NULL) ? task->parent : task); + iscsi_task *task = container_of( scsi_task, iscsi_task, scsi_task ); iscsi_connection *conn = task->conn; - if ( (((iscsi_scsi_cmd_packet *) primary_task->pdu->bhs_pkt)->flags_task & ISCSI_SCSI_CMD_FLAGS_TASK_READ) != 0 ) - iscsi_task_xfer_complete_process_read( conn, task, primary_task ); - else - iscsi_task_xfer_complete_process_other( conn, task, primary_task ); + task->des_data_xfer_pos += task->scsi_task.len; + + iscsi_task_response( conn, task, pdu ); + iscsi_task_destroy( task ); } /** @@ -3939,7 +669,7 @@ void iscsi_scsi_task_xfer_complete(iscsi_scsi_task *scsi_task) * @param[in] asc Additional Sense Code (ASC). * @param[in] ascq Additional Sense Code Qualifier (ASCQ). */ -void iscsi_scsi_task_sense_data_build(iscsi_scsi_task *scsi_task, const uint8_t sense_key, const uint8_t asc, const uint8_t ascq) +static void iscsi_scsi_task_sense_data_build(iscsi_scsi_task *scsi_task, const uint8_t sense_key, const uint8_t asc, const uint8_t ascq) { iscsi_scsi_sense_data_check_cond_packet *sense_data = (iscsi_scsi_sense_data_check_cond_packet *) scsi_task->sense_data; @@ -3964,7 +694,7 @@ void iscsi_scsi_task_sense_data_build(iscsi_scsi_task *scsi_task, const uint8_t sense_data->cmd_spec_info = 0UL; // Zero does not require endianess conversion sense_data->asc = asc; sense_data->ascq = ascq; - sense_data->field_rep_unit_code = 0U; + sense_data->field_rep_unit_code = 0UL; sense_data->sense_key_spec_flags = 0U; sense_data->sense_key_spec = 0U; // Zero does not require endianess conversion @@ -3996,44 +726,6 @@ static void iscsi_scsi_task_status_set(iscsi_scsi_task *scsi_task, const uint8_t } /** - * @brief Copies iSCSI SCSI task sense data and status code. - * - * This function allocates, if necessary, a - * SCSI sense data buffer and copies it over - * from source or deallocates the sense data - * buffer in case the source has no sense - * data. - * - * @param[in] dst_scsi_task Pointer to iSCSI SCSI task to copy to. - * May NOT be NULL, so be careful. - * @param[in] src_scsi_task Pointer to iSCSI SCSI task to copy from. - * NULL is NOT allowed here, take caution. - * @return 0 on successful copy operation, a negative - * error code otherwise. - */ -int iscsi_scsi_task_status_copy(iscsi_scsi_task *dst_scsi_task, const iscsi_scsi_task *src_scsi_task) -{ - if ( dst_scsi_task->sense_data != NULL ) - free( dst_scsi_task->sense_data ); - - if ( src_scsi_task->sense_data != NULL ) { - dst_scsi_task->sense_data = malloc( src_scsi_task->sense_data_len ); - - if ( dst_scsi_task == NULL ) - return -1; - - memcpy( dst_scsi_task->sense_data, src_scsi_task->sense_data, src_scsi_task->sense_data_len ); - } else { - dst_scsi_task->sense_data = NULL; - } - - dst_scsi_task->sense_data_len = src_scsi_task->sense_data_len; - dst_scsi_task->status = src_scsi_task->status; - - return 0; -} - -/** * @brief Processes a iSCSI SCSI task with no LUN identifier. * * This function only generates a SCSI response @@ -4045,7 +737,7 @@ int iscsi_scsi_task_status_copy(iscsi_scsi_task *dst_scsi_task, const iscsi_scsi * the task with no LUN identifier for. May NOT * be NULL, so be careful. */ -void iscsi_scsi_task_lun_process_none(iscsi_scsi_task *scsi_task) +static void iscsi_scsi_task_lun_process_none(iscsi_scsi_task *scsi_task) { iscsi_scsi_std_inquiry_data_packet std_inquiry_data_pkt; iscsi_scsi_cdb_inquiry *cdb = (iscsi_scsi_cdb_inquiry *) scsi_task->cdb; @@ -4077,172 +769,6 @@ void iscsi_scsi_task_lun_process_none(iscsi_scsi_task *scsi_task) } /** - * @brief Processes a iSCSI SCSI aborted task. - * - * This function will generate a SCSI error as - * specified by the SCSI standard. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to process - * the task to be aborted. May NOT be NULL, so - * be careful. - */ -void iscsi_scsi_task_lun_process_abort(iscsi_scsi_task *scsi_task) -{ - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ABORTED_COMMAND, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); -} - -/** - * @brief Allocates and initializes an iSCSI LUN structure for linkage with a DNBD3 image. - * - * This function does not set the DNBD3 - * image itself. - * - * @param[in] id LUN identifier. - * @return Pointer to ISCSI device LUN or NULL in case - * of an error (memory exhaustion). - */ -iscsi_scsi_lun *iscsi_scsi_lun_create(const int lun_id) -{ - iscsi_scsi_lun *lun = (iscsi_scsi_lun *) malloc( sizeof(struct iscsi_scsi_lun) ); - - if ( lun == NULL ) { - logadd( LOG_ERROR, "iscsi_scsi_lun_create: Out of memory allocating iSCSI device LUN" ); - - return NULL; - } - - iscsi_list_create( &lun->tasks ); - - if ( pthread_mutex_init( &lun->tasks_mutex, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_scsi_lun_create: Error while initializing tasks mutex for iSCSI device LUN" ); - - return NULL; - } - - iscsi_list_create( &lun->tasks_pending ); - - if ( pthread_mutex_init( &lun->tasks_pending_mutex, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_scsi_lun_create: Error while initializing pendings tasks mutex for iSCSI device LUN" ); - - pthread_mutex_destroy( &lun->tasks_mutex ); - - return NULL; - } - - iscsi_list_create( &lun->tasks_mgmt ); - - if ( pthread_mutex_init( &lun->tasks_mgmt_mutex, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_scsi_lun_create: Error while initializing management tasks mutex for iSCSI device LUN" ); - - pthread_mutex_destroy( &lun->tasks_pending_mutex ); - pthread_mutex_destroy( &lun->tasks_mutex ); - - return NULL; - } - - iscsi_list_create( &lun->tasks_mgmt_pending ); - - if ( pthread_mutex_init( &lun->tasks_mgmt_pending_mutex, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_scsi_lun_create: Error while initializing management pending tasks mutex for iSCSI device LUN" ); - - pthread_mutex_destroy( &lun->tasks_mgmt_mutex ); - pthread_mutex_destroy( &lun->tasks_pending_mutex ); - pthread_mutex_destroy( &lun->tasks_mutex ); - - return NULL; - } - - lun->pr_regs = iscsi_hashmap_create( 0U ); - - if ( lun->pr_regs == NULL ) { - logadd( LOG_ERROR, "iscsi_scsi_lun_create: Out of memory allocating iSCSI device LUN Persistent Reservation (PR) registrant for I_T nexus hash map" ); - - pthread_mutex_destroy( &lun->tasks_mgmt_pending_mutex ); - pthread_mutex_destroy( &lun->tasks_mgmt_mutex ); - pthread_mutex_destroy( &lun->tasks_pending_mutex ); - pthread_mutex_destroy( &lun->tasks_mutex ); - free( lun ); - - return NULL; - } - - lun->pr_reservation.holder = NULL; - lun->pr_reservation.cr_key = 0ULL; - lun->pr_reservation.type = 0; - lun->pr_reservation.flags = 0L; - - lun->pr_scsi2_holder.target_port = NULL; - lun->pr_scsi2_holder.target_name = NULL; - lun->pr_scsi2_holder.init_port = NULL; - lun->pr_scsi2_holder.init_name = NULL; - lun->pr_scsi2_holder.transport_id = NULL; - lun->pr_scsi2_holder.r_key = 0ULL; - lun->pr_scsi2_holder.rel_target_port_id = 0U; - lun->pr_scsi2_holder.transport_id_len = 0U; - - lun->device = NULL; - lun->image = NULL; - lun->id = lun_id; - lun->flags = 0; - lun->pr_gen = 0UL; - - return lun; -} - -/** - * @brief iSCSI SCSI LUN destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * SCSI LUN stored in the iSCSI device hash map. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_scsi_lun_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_scsi_lun_destroy( (iscsi_scsi_lun *) value ); - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** - * @brief Deallocates all resources acquired by iscsi_scsi_lun_create. - * - * This function does not deallocate the - * associated DNBD3 image and therefore - * just deallocates the associated SCSI - * tasks. - * - * @param[in] lun Pointer to iSCSI device LUN to be freed. - * May be NULL in which case this function - * does nothing at all. - */ -void iscsi_scsi_lun_destroy(iscsi_scsi_lun *lun) -{ - if ( lun != NULL ) { - if ( lun->pr_regs != NULL ) { - // iscsi_hashmap_iterate( lun->pr_regs, iscsi_scsi_pr_registrant_destroy_callback, NULL ); - iscsi_hashmap_destroy( lun->pr_regs ); - - lun->pr_regs = NULL; - } - - pthread_mutex_destroy( &lun->tasks_mgmt_pending_mutex ); - pthread_mutex_destroy( &lun->tasks_mgmt_mutex ); - pthread_mutex_destroy( &lun->tasks_pending_mutex ); - pthread_mutex_destroy( &lun->tasks_mutex ); - free( lun ); - } -} - -/** * @brief Converts an internal representation of a LUN identifier to an iSCSI LUN required for packet data. * * This function needs to be called prior @@ -4255,7 +781,7 @@ void iscsi_scsi_lun_destroy(iscsi_scsi_lun *lun) * @return iSCSI packet data representation of LUN or * 0 in case of an invalid LUN. */ -uint64_t iscsi_scsi_lun_get_from_scsi(const int lun_id) +static uint64_t iscsi_scsi_lun_get_from_scsi(const int lun_id) { uint64_t iscsi_scsi_lun; @@ -4284,7 +810,7 @@ uint64_t iscsi_scsi_lun_get_from_scsi(const int lun_id) * packet data LUN or 0xFFFF in case of * an error. */ -int iscsi_scsi_lun_get_from_iscsi(const uint64_t lun) +static int iscsi_scsi_lun_get_from_iscsi(const uint64_t lun) { int lun_id = (int) (lun >> 62ULL) & 0x03; @@ -4299,75 +825,6 @@ int iscsi_scsi_lun_get_from_iscsi(const uint64_t lun) } /** - * @brief Appends an iSCSI SCSI task to a iSCSI SCSI LUN pending tasks doubly linked list. - * - * This function cannot fail. - * - * @param[in] lun Pointer to iSCSI SCSI LUN to append the - * task to, may NOT be NULL, so be careful. - * @param[in] scsi_task Pointer to iSCSI SCSI task to be - * appended. NULL is NOT an allowed value, so take - * caution. - */ -void iscsi_scsi_lun_task_append(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task) -{ - iscsi_list_enqueue( &lun->tasks_pending, &scsi_task->node ); -} - -/** - * @brief Executes all iSCSI SCSI pending tasks assigned to a iSCSI SCSI LUN. - * - * This function also removes the pending tasks - * from the hash map of the SCSI LUN. - * - * @param[in] lun Pointer to ISCSI SCSI LUN of which the - * pending tasks should be executed and may NOT - * be NULL, so be careful. - */ -void iscsi_scsi_lun_tasks_exec(iscsi_scsi_lun *lun) -{ - while ( !iscsi_list_empty( &lun->tasks_pending ) ) { - iscsi_scsi_task *scsi_task = (iscsi_scsi_task *) iscsi_list_peek( &lun->tasks_pending ); - - iscsi_list_remove( &scsi_task->node ); - pthread_mutex_unlock( &lun->tasks_pending_mutex ); - iscsi_scsi_lun_task_run( lun, scsi_task ); - pthread_mutex_lock( &lun->tasks_pending_mutex ); - } -} - -/** - * @brief Checks whether the iSCSI SCSI task requires unit attention. - * - * This function parses the SCSI opcode of the - * SCSI Command Descriptor Block (CDB). - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to check - * unit attention for which may NOT be NULL, - * so be careful. - * @retval true Unit attention is required. - * @retval false Unit attention is NOT required. - */ -static bool iscsi_scsi_lun_handle_unit_attention(iscsi_scsi_task *scsi_task) -{ - switch ( scsi_task->cdb->opcode ) { - case ISCSI_SCSI_OPCODE_INQUIRY : - case ISCSI_SCSI_OPCODE_REPORTLUNS : - case ISCSI_SCSI_OPCODE_REQUESTSENSE : { - return false; - - break; - } - default : { - return true; - - break; - } - - } -} - -/** * @brief Runs an iSCSI SCSI task for a specified iSCSI SCSI LUN. * * This function moves the task back to the @@ -4376,681 +833,31 @@ static bool iscsi_scsi_lun_handle_unit_attention(iscsi_scsi_task *scsi_task) * Errors are nandled according to the SCSI * standard. * - * @param[in] lun Pointer to iSCSI SCSI LUN of which the - * task should be run and may NOT be NULL, - * so be careful. * @param[in] scsi_task Pointer to iSCSI SCSI task to be run. * NULL is NOT valid here, take caution. + * @param pdu */ -void iscsi_scsi_lun_task_run(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task) +static void iscsi_scsi_lun_task_run( iscsi_scsi_task *scsi_task, iscsi_pdu *pdu) { int rc; - pthread_mutex_lock( &lun->tasks_mutex ); - iscsi_list_enqueue( &lun->tasks, &scsi_task->node ); - pthread_mutex_unlock( &lun->tasks_mutex ); - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - if ( (lun->flags & ISCSI_SCSI_LUN_FLAGS_REMOVED) != 0 ) { - iscsi_scsi_task_lun_process_abort( scsi_task ); - - rc = ISCSI_SCSI_TASK_RUN_COMPLETE; - } else if ( ((lun->flags & ISCSI_SCSI_LUN_FLAGS_RESIZING) != 0) && iscsi_scsi_lun_handle_unit_attention( scsi_task ) ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_UNIT_ATTENTION, ISCSI_SCSI_ASC_CAPACITY_DATA_HAS_CHANGED, ISCSI_SCSI_ASCQ_CAPACITY_DATA_HAS_CHANGED ); - - lun->flags &= ~ISCSI_SCSI_LUN_FLAGS_RESIZING; + rc = iscsi_scsi_emu_block_process( scsi_task ); - rc = ISCSI_SCSI_TASK_RUN_COMPLETE; - } else { - if ( (lun->pr_reservation.flags & ISCSI_SCSI_PR_RESERVATION_FLAGS_SPC2_RESERVE) != 0 ) - rc = iscsi_scsi_pr_check_scsi2( scsi_task ); - else - rc = iscsi_scsi_pr_check( scsi_task ); + if ( rc == ISCSI_SCSI_TASK_RUN_UNKNOWN ) { + rc = iscsi_scsi_emu_primary_process( scsi_task ); - if ( rc < 0 ) + if ( rc == ISCSI_SCSI_TASK_RUN_UNKNOWN ) { + iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_COMMAND_OPERATION_CODE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); + // TODO: Free task rc = ISCSI_SCSI_TASK_RUN_COMPLETE; - else - rc = iscsi_scsi_emu_exec( scsi_task ); - } - - if ( rc == ISCSI_SCSI_TASK_RUN_COMPLETE ) - iscsi_scsi_lun_task_complete( lun, scsi_task ); -} - -/** - * @brief Handles iSCSI SCSI task completition. - * - * This function removes the completed task from - * the iSCSI SCSI LUN task doubly linked list - * and calls the transfer finished callback - * function. - * - * @param[in] lun Pointer to iSCSI SCSI LUN to remove the task - * from. - * @param[in] scsi_task Pointer to iSCSI SCSI task to be removed - * and to invoke the transfer finished callback - * of and may NOT be NULL, so be careful. - */ -void iscsi_scsi_lun_task_complete(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task) -{ - if ( lun != NULL ) - iscsi_list_remove( &scsi_task->node ); - - scsi_task->xfer_complete_callback( scsi_task ); -} - -/** - * @brief Appends iSCSI SCSI task to pending tasks doubly linked list and / or runs it directly. - * - * This function checks whether there are pending - * task management pending tasks to be executed - * first.\n - * If there are pending tasks enqueued, they will - * be executed prior this new task.\n - * If this is the only one task, it will be - * executed immediately. - * - * @param[in] lun Pointer to iSCSI SCSI LUN which should be - * checked for pending tasks prior execution. May - * NOT be NULL, so be careful. - * @param[in] scsi_task Pointer to iSCSI SCSI task to either be - * enqueued and run or to be run directly. - */ -void iscsi_scsi_lun_task_exec(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task) -{ - pthread_mutex_lock( &lun->tasks_mgmt_pending_mutex ); - - if ( !iscsi_list_empty( &lun->tasks_mgmt_pending ) ) { - pthread_mutex_unlock( &lun->tasks_mgmt_pending_mutex ); - pthread_mutex_lock( &lun->tasks_pending_mutex ); - iscsi_scsi_lun_task_append( lun, scsi_task ); - pthread_mutex_unlock( &lun->tasks_pending_mutex ); - - return; - } - - pthread_mutex_unlock( &lun->tasks_mgmt_pending_mutex ); - pthread_mutex_lock( &lun->tasks_pending_mutex ); - - if ( !iscsi_list_empty( &lun->tasks_pending ) ) { - iscsi_scsi_lun_task_append( lun, scsi_task ); - iscsi_scsi_lun_tasks_exec( lun ); - pthread_mutex_unlock( &lun->tasks_pending_mutex ); - - return; - } - - pthread_mutex_unlock( &lun->tasks_pending_mutex ); - - iscsi_scsi_lun_task_run( lun, scsi_task ); -} - -/** - * @brief Checks if iSCSI SCSI Persistent Reservation (PR) SCSI-2 I_T nexus is holder. - * - * This function compares the target and - * initiator name with the registrant. - * - * @param[in] lun Pointer to iSCSI SCSI LUN to be - * checked, may NOT be NULL, so be careful. - * @param[in] target_port Pointer to iSCSI target port to - * check for. - * @param[in] init_port Pointer to iSCSI initiator port to - * check for. - * @retval true The iSCSI SCSI Persistent Reservation - * (PR) SCSI-2 I_T nexus is actually the holder. - * @retval false The iSCSI SCSI Persistent Reservation - * (PR) SCSI-2 I_T nexus is NOT the holder. - */ -static inline bool iscsi_scsi_pr_check_scsi2_it_nexus_is_holder(const iscsi_scsi_lun *lun, const iscsi_port *target_port, const iscsi_port *init_port) -{ - const iscsi_scsi_pr_registrant *reg = lun->pr_reservation.holder; - - return ((reg->target_port == target_port) && (reg->init_port == init_port)); -} - -/** - * @brief Checks the iSCSI SCSI Persistent Reservation (PR) SCSI-2 reserve of an iSCSI SCSI task. - * - * This function also sets the SCSI error - * code if the check fails. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to be - * checked for and may NOT be NULL, so - * be careful. - * @return 0 on successful check, a negative - * error code otherwise. - */ -int iscsi_scsi_pr_check_scsi2(iscsi_scsi_task *scsi_task) -{ - const iscsi_scsi_lun *lun = scsi_task->lun; - - switch ( scsi_task->cdb->opcode ) { - case ISCSI_SCSI_OPCODE_INQUIRY : - case ISCSI_SCSI_OPCODE_RELEASE6 : - case ISCSI_SCSI_OPCODE_RELEASE10 : { - return ISCSI_SCSI_TASK_RUN_COMPLETE; - - break; - } - default : { - break; } } - if ( (lun->pr_reservation.holder == NULL) || iscsi_scsi_pr_check_scsi2_it_nexus_is_holder( lun, scsi_task->target_port, scsi_task->init_port ) ) - return ISCSI_SCSI_TASK_RUN_COMPLETE; - - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; -} - -/** - * @brief Finds an iSCSI SCSI Persistent Reservation (PR) registrant by target and initiator port. - * - * Callback function for each element while iterating - * through the iSCSI SCSI LUN Persistent Reservation - * (PR) registrants hash map. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL creates an - * empty key assignment. - * @param[in,out] user_data Pointer to a data structure - * containing the iSCSI SCSI Persistent Reservation - * (PR) registrant and the target, as well as the - * initiator port to be searched for and may NOT be - * NULL, so be careful. - * @retval -1 The registrant has been found and stored - * in the result structure. Therefore, no further - * searching is needed. - * @retval 0 The registrant has not been found yet. - */ -int iscsi_scsi_pr_registrant_get_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_scsi_pr_registrant_get_reg *reg_find = (iscsi_scsi_pr_registrant_get_reg *) user_data; - iscsi_scsi_pr_registrant *reg = (iscsi_scsi_pr_registrant *) value; - - if ( (reg_find->target_port != reg->target_port) || (reg_find->init_port != reg->init_port) ) - return 0; - - reg_find->reg = reg; - - return -1; -} - -/** - * @brief Searches an iSCSI SCSI Persistent Reservation (PR) registrant by target and initiator port. - * - * This function searches for an iSCSI SCSI Persistent - * Reservation (PR) registrant by iterating through - * the iSCSI SCSI LUN Persistent Reservation (PR) - * registrants hash map. - * - * @param[in] lun Pointer to iSCSI SCSI LUN to - * search in the Persistent Reservation (PR) - * registrants hash map. May NOT be NULL, so be - * careful. - * @param[in] target_port Pointer to iSCSI target port to - * search for. - * @param[in] init_port Pointer to iSCSI initiator port to - * search for. - * @return Pointer to found iSCSI SCSI Persistent - * Reservation (PR) registrant or NULL in case no - * registrant has a matching target and Initiator - * port. - */ -static iscsi_scsi_pr_registrant *iscsi_scsi_pr_registrant_get(const iscsi_scsi_lun *lun, iscsi_port *target_port, iscsi_port *init_port) -{ - iscsi_scsi_pr_registrant_get_reg reg_find = {NULL, target_port, init_port}; - - iscsi_hashmap_iterate( lun->pr_regs, iscsi_scsi_pr_registrant_get_callback, (uint8_t *) ®_find ); - - return reg_find.reg; -} - -/** - * @brief Checks whether iSCSI SCSI Persistent Reservation (PR) reservation type is all registrants or not. - * - * This function checks both if write exclusive and - * exclusive access types. - * - * @param[in] lun Pointer to iSCSI SCSI LUN to - * check the Persistent Reservation (PR) - * reservation's type. May NOT be NULL, so be - * careful. - * @retval true The iSCSI SCSI Persistent Reservation (PR) - * reservation type is set to all registrants. - * @retval false The iSCSI SCSI Persistent Reservation (PR) - * reservation type is NOT set to all registrants. - */ -static inline bool iscsi_scsi_pr_check_is_all_type(const iscsi_scsi_lun *lun) -{ - return ((lun->pr_reservation.type == ISCSI_SCSI_PR_RESERVATION_TYPE_WRITE_EXCLUSIVE_ALL_REGS) || (lun->pr_reservation.type == ISCSI_SCSI_PR_RESERVATION_TYPE_EXCLUSIVE_ACCESS_ALL_REGS)); -} - -/** - * @brief Checks whether iSCSI SCSI Persistent Reservation (PR) reservation holder is the specified registrant or not. - * - * This function also checks if reservation type is - * all registrants or not. - * - * @param[in] lun Pointer to iSCSI SCSI LUN to - * check the Persistent Reservation (PR) - * reservation holder for. May NOT be NULL, so be - * careful. - * @param[in] reg Pointer to iSCSI SCSI Persistent - * Reservation (PR) registrant to check for. - * @retval true The iSCSI SCSI Persistent Reservation (PR) - * reservation holder matches the registrant. - * @retval false The iSCSI SCSI Persistent Reservation (PR) - * reservation holder does NOT match the registrant. - */ -static inline bool iscsi_scsi_pr_check_registrant_is_holder(const iscsi_scsi_lun *lun, const iscsi_scsi_pr_registrant *reg) -{ - return (((reg != NULL) && iscsi_scsi_pr_check_is_all_type( lun )) || (lun->pr_reservation.holder == reg)); -} - -/** - * @brief Checks the iSCSI SCSI Persistent Reservation (PR) of an iSCSI SCSI task. - * - * This function also sets the SCSI error - * code if the check fails. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to be - * checked for and may NOT be NULL, so - * be careful. - * @return 0 on successful check, a negative - * error code otherwise. - */ -int iscsi_scsi_pr_check(iscsi_scsi_task *scsi_task) -{ - const iscsi_scsi_lun *lun = scsi_task->lun; - const iscsi_scsi_pr_registrant *reg = iscsi_scsi_pr_registrant_get( lun, scsi_task->target_port, scsi_task->init_port ); - - if ( (reg == NULL) || ((reg->target_port == scsi_task->target_port) && (reg->init_port == scsi_task->init_port)) ) - return ISCSI_SCSI_TASK_RUN_COMPLETE; - - const iscsi_scsi_cdb *cdb = (iscsi_scsi_cdb *) scsi_task->cdb; - bool dma_to_device = false; - - switch ( cdb->opcode ) { - case ISCSI_SCSI_OPCODE_INQUIRY : - case ISCSI_SCSI_OPCODE_REPORTLUNS : - case ISCSI_SCSI_OPCODE_REQUESTSENSE : - case ISCSI_SCSI_OPCODE_LOGSENSE : - case ISCSI_SCSI_OPCODE_TESTUNITREADY : - case ISCSI_SCSI_OPCODE_STARTSTOPUNIT : - case ISCSI_SCSI_OPCODE_READCAPACITY10 : - case ISCSI_SCSI_OPCODE_PERSISTENT_RESERVE_IN : - case ISCSI_SCSI_OPCODE_SERVICE_ACTION_IN_16 : - case ISCSI_SCSI_OPCODE_RESERVE6 : - case ISCSI_SCSI_OPCODE_RESERVE10 : - case ISCSI_SCSI_OPCODE_RELEASE6 : - case ISCSI_SCSI_OPCODE_RELEASE10 : { - return ISCSI_SCSI_TASK_RUN_COMPLETE; - - break; - } - case ISCSI_SCSI_OPCODE_MODESELECT6 : - case ISCSI_SCSI_OPCODE_MODESELECT10 : - case ISCSI_SCSI_OPCODE_MODESENSE6 : - case ISCSI_SCSI_OPCODE_MODESENSE10 : - case ISCSI_SCSI_OPCODE_LOGSELECT : { - if ( reg == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - } - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - - break; - } - case ISCSI_SCSI_OPCODE_PERSISTENT_RESERVE_OUT : { - const iscsi_scsi_cdb_pr_reserve_out *cdb_pr_reserve_out = (iscsi_scsi_cdb_pr_reserve_out *) cdb; - const uint8_t action = ISCSI_SCSI_CDB_PR_RESERVE_OUT_GET_ACTION(cdb_pr_reserve_out->action); - - switch ( action ) { - case ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_REGISTER : - case ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_REGISTER_IGNORE_EXIST_KEY : { - return ISCSI_SCSI_TASK_RUN_COMPLETE; - - break; - } - case ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_RELEASE : - case ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_CLEAR : - case ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_PREEMPT : - case ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_PREEMPT_ABORT : { - if ( reg == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - } - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - - break; - } - default : { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - - break; - - } - } - - break; - } - case ISCSI_SCSI_OPCODE_READ6 : - case ISCSI_SCSI_OPCODE_READ10 : - case ISCSI_SCSI_OPCODE_READ12 : - case ISCSI_SCSI_OPCODE_READ16 : { - break; - } - case ISCSI_SCSI_OPCODE_WRITE6 : - case ISCSI_SCSI_OPCODE_WRITE10 : - case ISCSI_SCSI_OPCODE_WRITE12 : - case ISCSI_SCSI_OPCODE_WRITE16 : - case ISCSI_SCSI_OPCODE_UNMAP : - case ISCSI_SCSI_OPCODE_SYNCHRONIZECACHE10 : - case ISCSI_SCSI_OPCODE_SYNCHRONIZECACHE16 : { - dma_to_device = true; - - break; - } - default : { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - - break; - } + if ( rc == ISCSI_SCSI_TASK_RUN_COMPLETE ) { + iscsi_scsi_task_xfer_complete( scsi_task, pdu ); } - - switch ( lun->pr_reservation.type ) { - case ISCSI_SCSI_PR_RESERVATION_TYPE_WRITE_EXCLUSIVE : { - if ( dma_to_device ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - } - - break; - } - case ISCSI_SCSI_PR_RESERVATION_TYPE_EXCLUSIVE_ACCESS : { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - - break; - } - case ISCSI_SCSI_PR_RESERVATION_TYPE_WRITE_EXCLUSIVE_REGS_ONLY : - case ISCSI_SCSI_PR_RESERVATION_TYPE_WRITE_EXCLUSIVE_ALL_REGS : { - if ( (reg == NULL) && dma_to_device ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - } - - break; - } - case ISCSI_SCSI_PR_RESERVATION_TYPE_EXCLUSIVE_ACCESS_REGS_ONLY : - case ISCSI_SCSI_PR_RESERVATION_TYPE_EXCLUSIVE_ACCESS_ALL_REGS : { - if ( reg == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_RESERVATION_CONFLICT, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - } - - break; - } - default : { - break; - } - } - - return ISCSI_SCSI_TASK_RUN_COMPLETE; -} - -/** - * @brief Constructs an iSCSI SCSI Persistent Reservation (PR) out parameter list of an iSCSI SCSI task. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to - * construct Persistent Reservation (PR) - * out parameter list for. May NOT be NULL, - * so be careful. - * @param[in] pr_reserve_out_parameter_list Pointer to iSCSI SCSI Persistent - * Reservation (PR) out parameter list. NULL - * is NOT allowed here, take caution. - * @param[in] cdb_pr_reserve_out Pointer to iSCSI SCSI Command - * Descriptor Block (CDB) to construct the - * out data from and may NOT be NULL, so be - * careful. - * @param[in] len Length of parameter list in bytes. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -int iscsi_scsi_pr_out(iscsi_scsi_task *scsi_task, iscsi_scsi_pr_reserve_out_parameter_list_packet *pr_reserve_out_parameter_list, const iscsi_scsi_cdb_pr_reserve_out *cdb_pr_reserve_out, const uint len) -{ - // TODO: Implement function. - - return 0; -} - -/** - * @brief Constructs iSCSI SCSI Persistent Reservation (PR) in parameter data of an iSCSI SCSI task. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to - * construct Persistent Reservation (PR) - * in parameter data for. May NOT be NULL, - * so be careful. - * @param[in] pr_reserve_in_parameter_data Pointer to iSCSI SCSI Persistent - * Reservation (PR) in parameter data. NULL - * is NOT allowed here, take caution. - * @param[in] cdb_pr_reserve_in Pointer to iSCSI SCSI Command - * Descriptor Block (CDB) to construct the - * in data from and may NOT be NULL, so be - * careful. - * @param[in] len Length of parameter data in bytes. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -int iscsi_scsi_pr_in(iscsi_scsi_task *scsi_task, iscsi_scsi_pr_reserve_in_parameter_data_packet *pr_reserve_in_parameter_data, const iscsi_scsi_cdb_pr_reserve_in *cdb_pr_reserve_in, const uint len) -{ - // TODO: Implement function. - - return 0; -} - -/** - * @brief Reserves an iSCSI SCSI Persistent Reservation (PR) of an iSCSI SCSI task. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to - * reserve the Persistent Reservation - * (PR) for. May NOT be NULL, so be - * careful. - * @param[in] cdb_pr_reserve_6 Pointer to iSCSI SCSI Command - * Descriptor Block (CDB) to reserve the - * data from. NULL is NOT allowed here, - * take caution. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -int iscsi_scsi_pr_reserve_scsi2(iscsi_scsi_task *scsi_task, const iscsi_scsi_cdb_pr_reserve_6 *cdb_pr_reserve_6) -{ - // TODO: Implement function. - - return 0; -} - -/** - * @brief Releases an iSCSI SCSI Persistent Reservation (PR) of an iSCSI SCSI task. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task to - * release the Persistent Reservation - * (PR) for. May NOT be NULL, so be - * careful. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -int iscsi_scsi_pr_release_scsi2(iscsi_scsi_task *scsi_task) -{ - // TODO: Implement function. - - return 0; -} - -/** - * @brief Checks whether an I/O feature is supported by a DNBD3 image. - * - * This function depends on DNBD3 image - * properties and queries only one I/O - * feature at once. - * - * @param[in] image Pointer to DNBD3 image to check I/O - * attributes for. May NOT be NULL, so be - * careful. - * @param[in] type I/O type to be checked for. - * @retval true The DNBD3 image supports the I/O feature. - * @retval false The I/O feature is NOT supported for the - * DNBD3 image. - */ -static inline bool iscsi_scsi_emu_io_type_is_supported(const dnbd3_image_t *image, const int type) -{ - // TODO: Actually implement this function. - - int32_t flags; - - switch ( type ) { - case ISCSI_SCSI_EMU_IO_TYPE_REMOVABLE : { - flags = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_REMOVABLE ); - - if ( flags < 0L ) - flags = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_REMOVABLE ); - - return (bool) flags; - - break; - } - case ISCSI_SCSI_EMU_IO_TYPE_UNMAP : { - flags = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_UNMAP ); - - if ( flags < 0L ) - flags = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_UNMAP ); - - return (bool) flags; - - break; - } - case ISCSI_SCSI_EMU_IO_TYPE_NO_ROTATION : { - flags = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_NO_ROTATION ); - - if ( flags < 0L ) - flags = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_NO_ROTATION ); - - return (bool) flags; - - break; - } - case ISCSI_SCSI_EMU_IO_TYPE_PHYSICAL_READ_ONLY : { - flags = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY ); - - if ( flags < 0L ) - flags = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY ); - - return (bool) flags; - - break; - } - case ISCSI_SCSI_EMU_IO_TYPE_WRITE_PROTECT : { - flags = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_PROTECT ); - - if ( flags < 0L ) - flags = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_PROTECT ); - - return (bool) flags; - - break; - } - case ISCSI_SCSI_EMU_IO_TYPE_WRITE_CACHE : { - flags = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_CACHE ); - - if ( flags < 0L ) - flags = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_CACHE ); - - return (bool) flags; - - break; - } - default : { - return false; - - break; - } - } - - return false; -} - -/** - * @brief Retrieves the number of total physical blocks for a DNBD3 image. - * - * This function depends on DNBD3 image - * properties. - * - * @param[in] image Pointer to DNBD3 image to retrieve - * the physical size from. May NOT be NULL, - * so be careful. - * @return The number of total physical blocks. - */ -static inline uint64_t iscsi_scsi_emu_physical_block_get_count(const dnbd3_image_t *image) -{ - int32_t block_size_shift = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE_SHIFT ); - - if ( block_size_shift < 0L ) - block_size_shift = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE_SHIFT ); - - return (image->virtualFilesize >> (uint32_t) block_size_shift); -} - -/** - * @brief Retrieves the bit shift of a physical block in bytes for a DNBD3 image. - * - * This function depends on DNBD3 image - * properties. - * - * @param[in] image Pointer to DNBD3 image to retrieve - * the physical bit shift size. May NOT - * be NULL, so be careful. - * @return The physical block size in bytes as a - * bit shift count. - */ -static inline uint32_t iscsi_scsi_emu_physical_block_get_size_shift(const dnbd3_image_t *image) -{ - int32_t block_size_shift = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE_SHIFT ); - - if ( block_size_shift < 0L ) - block_size_shift = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE_SHIFT ); - - return block_size_shift; } /** @@ -5066,12 +873,7 @@ static inline uint32_t iscsi_scsi_emu_physical_block_get_size_shift(const dnbd3_ */ static inline uint32_t iscsi_scsi_emu_physical_block_get_size(const dnbd3_image_t *image) { - int32_t block_size = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE ); - - if ( block_size < 0L ) - block_size = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE ); - - return block_size; + return ISCSI_SCSI_EMU_PHYSICAL_BLOCK_SIZE; } /** @@ -5087,92 +889,7 @@ static inline uint32_t iscsi_scsi_emu_physical_block_get_size(const dnbd3_image_ */ static inline uint64_t iscsi_scsi_emu_block_get_count(const dnbd3_image_t *image) { - int32_t block_size_shift = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE_SHIFT ); - - if ( block_size_shift < 0L ) - block_size_shift = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE_SHIFT ); - - return (image->virtualFilesize >> (uint32_t) block_size_shift); -} - -/** - * @brief Retrieves the bit shift of a logical block in bytes for a DNBD3 image. - * - * This function depends on DNBD3 image - * properties. - * - * @param[in] image Pointer to DNBD3 image to retrieve - * the logical block bit shift size. - * May NOT be NULL, so be careful. - * @return The logical block size in bytes as a - * bit shift count. - */ -static inline uint32_t iscsi_scsi_emu_block_get_size_shift(const dnbd3_image_t *image) -{ - int32_t block_size_shift = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE_SHIFT ); - - if ( block_size_shift < 0L ) - block_size_shift = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE_SHIFT ); - - return block_size_shift; -} - -/** - * @brief Retrieves the size of a logical block in bytes for a DNBD3 image. - * - * This function depends on DNBD3 image - * properties. - * - * @param[in] image Pointer to DNBD3 image to retrieve - * the logical block size. May NOT be NULL, - * so be careful. - * @return The logical block size in bytes. - */ -static inline uint32_t iscsi_scsi_emu_block_get_size(const dnbd3_image_t *image) -{ - int32_t block_size = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE ); - - if ( block_size < 0L ) - block_size = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE ); - - return block_size; -} - -/** - * @brief Retrieves the bit shift ratio between logical and physical block size for a DNBD3 image. - * - * This function depends on DNBD3 image - * properties. - * - * @param[in] image Pointer to DNBD3 image to retrieve - * the ratio between the logical and - * physical block size. May NOT be - * NULL, so be careful. - * @return The ratio between logical and physical - * block size as a logical bit shift - * count. - */ -static inline uint32_t iscsi_scsi_emu_block_get_ratio_shift(const dnbd3_image_t *image) -{ - return (iscsi_scsi_emu_physical_block_get_size_shift( image ) - iscsi_scsi_emu_block_get_size_shift( image )); -} - -/** - * @brief Retrieves the ratio between logical and physical block size for a DNBD3 image. - * - * This function depends on DNBD3 image - * properties. - * - * @param[in] image Pointer to DNBD3 image to retrieve - * the ratio between the logical and - * physical block size. May NOT be - * NULL, so be careful. - * @return The ratio between logical logical and physical - * block size. - */ -static inline uint32_t iscsi_scsi_emu_block_get_ratio(const dnbd3_image_t *image) -{ - return (1UL << iscsi_scsi_emu_block_get_ratio_shift( image )); + return (image->virtualFilesize / ISCSI_SCSI_EMU_BLOCK_SIZE); } /** @@ -5194,51 +911,32 @@ static inline uint32_t iscsi_scsi_emu_block_get_ratio(const dnbd3_image_t *image * bytes is aligned to block size or a * positive value if unaligned. */ -static uint64_t iscsi_scsi_emu_bytes_to_blocks(uint64_t *offset_blocks, uint64_t *num_blocks, const uint64_t offset_bytes, const uint64_t num_bytes, const uint32_t block_size) +static uint64_t iscsi_scsi_emu_bytes_to_blocks(uint64_t *offset_blocks, uint64_t *num_blocks, const uint64_t offset_bytes, const uint64_t num_bytes) { - if ( iscsi_is_pow2( block_size ) ) { - const uint32_t shift = iscsi_get_log2_of_pow2( block_size ); - - *offset_blocks = (offset_bytes >> shift); - *num_blocks = (num_bytes >> shift); - - return ((offset_bytes - (*offset_blocks << shift)) | (num_bytes - (*num_blocks << shift))); - } - - *offset_blocks = (offset_bytes / block_size); - *num_blocks = (num_bytes / block_size); + *offset_blocks = (offset_bytes / ISCSI_SCSI_EMU_BLOCK_SIZE); + *num_blocks = (num_bytes / ISCSI_SCSI_EMU_BLOCK_SIZE); - return ((offset_bytes % block_size) | (num_bytes % block_size)); + return ((offset_bytes % ISCSI_SCSI_EMU_BLOCK_SIZE) | (num_bytes % ISCSI_SCSI_EMU_BLOCK_SIZE)); } /** - * @brief Enqueues an I/O task in the waiting queue. + * @brief Converts offset and length specified by a block size to offset and length in bytes. * - * This function invokes a callback function - * with optional user data. + * This function uses bit shifting if + * the block size is a power of two. * - * @param[in] scsi_task Pointer to iSCSI SCSI task associated - * to the I/O process in the waiting queue. - * May NOT be NULL, so be careful. - * @param[in] callback Pointer to an I/O wait callback - * function which executes the pending I/O - * operation. NULL is NOT allowed here, so - * take caution. - * @param[in] user_data Pointer to optional user data for - * the callback function. - * @retval -1 The I/O task could not be - * run in the waiting queue. - * @retval 0 The I/O task has been added - * successfully in the I/O task waiting - * queue. + * @param[out] offset_bytes Pointer where to store the block + * in bytes. May NOT be NULL, so be + * careful. + * @param[in] offset_blocks Offset in blocks. + * @param[in] num_blocks Number of blocks. + * @return Number of blocks in bytes. */ -static int iscsi_scsi_emu_queue_io_wait(iscsi_scsi_task *scsi_task, iscsi_scsi_emu_io_wait_callback callback, uint8_t *user_data) +static uint64_t iscsi_scsi_emu_blocks_to_bytes(uint64_t *offset_bytes, const uint64_t offset_blocks, const uint64_t num_blocks) { - scsi_task->io_wait.image = scsi_task->lun->image; - scsi_task->io_wait.callback = callback; - scsi_task->io_wait.user_data = user_data; + *offset_bytes = (offset_blocks * ISCSI_SCSI_EMU_BLOCK_SIZE); - return iscsi_scsi_emu_io_queue( &scsi_task->io_wait ); + return (num_blocks * ISCSI_SCSI_EMU_BLOCK_SIZE); } /** @@ -5250,7 +948,8 @@ static int iscsi_scsi_emu_queue_io_wait(iscsi_scsi_task *scsi_task, iscsi_scsi_e * * @param[in] data Pointer to related scsi_task. May NOT * be NULL, so be careful. - * @param[in] handle Uplink handle. + * @param[in] handle Pointer to destination buffer, as passed to + * iscsi_scsi_emu_io_block_read(). * @param[in] start Start of range in bytes. * @param[in] length Length of range in bytes, as passed to * uplink_request(). @@ -5268,35 +967,6 @@ static void iscsi_uplink_callback(void *data, uint64_t handle UNUSED, uint64_t s } /** - * @brief Converts offset and length specified by a block size to offset and length in bytes. - * - * This function uses bit shifting if - * the block size is a power of two. - * - * @param[out] offset_bytes Pointer where to store the block - * in bytes. May NOT be NULL, so be - * careful. - * @param[in] offset_blocks Offset in blocks. - * @param[in] num_blocks Number of blocks. - * @param[in] block_size Block size in bytes. - * @return Number of blocks in bytes. - */ -static uint64_t iscsi_scsi_emu_blocks_to_bytes(uint64_t *offset_bytes, const uint64_t offset_blocks, const uint64_t num_blocks, const uint32_t block_size) -{ - if ( iscsi_is_pow2( block_size ) ) { - const uint32_t shift = iscsi_get_log2_of_pow2( block_size ); - - *offset_bytes = (offset_blocks << shift); - - return (num_blocks << shift); - } - - *offset_bytes = (offset_blocks * block_size); - - return (num_blocks * block_size); -} - -/** * @brief Reads a number of blocks from a block offset of a DNBD3 image to a specified buffer. * * This function enqueues the I/O read @@ -5313,22 +983,16 @@ static uint64_t iscsi_scsi_emu_blocks_to_bytes(uint64_t *offset_bytes, const uin * @param[in] offset_blocks Offset in blocks to start reading from. * @param[in] num_blocks Number of blocks to read. * @param[in] block_size Block size in bytes. - * @param[in] callback Pointer to callback function to invoke - * after I/O read operation has been - * finished. NULL is a prohibited - * value, so be careful. - * @param[in] user_data Pointer to user data passed to the - * callback function. * @return 0 on successful operation, a negative * error code otherwise. */ -int iscsi_scsi_emu_io_block_read(iscsi_scsi_task *scsi_task, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks, const uint32_t block_size, iscsi_scsi_emu_io_complete_callback callback, uint8_t *user_data) +static int iscsi_scsi_emu_io_blocks_read(iscsi_scsi_task *scsi_task, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks) { uint64_t offset_bytes; - const uint64_t num_bytes = iscsi_scsi_emu_blocks_to_bytes( &offset_bytes, offset_blocks, num_blocks, block_size ); + const uint64_t num_bytes = iscsi_scsi_emu_blocks_to_bytes( &offset_bytes, offset_blocks, num_blocks ); + dnbd3_cache_map_t *cache = ref_get_cachemap( image ); bool readFromFile; - bool success; if ( cache == NULL ) { readFromFile = true; @@ -5342,212 +1006,42 @@ int iscsi_scsi_emu_io_block_read(iscsi_scsi_task *scsi_task, dnbd3_image_t *imag if ( !readFromFile ) { // Not cached, request via uplink + pthread_mutex_init( &scsi_task->uplink_mutex, NULL ); + pthread_cond_init( &scsi_task->uplink_cond, NULL ); + pthread_mutex_lock( &scsi_task->uplink_mutex ); - if ( pthread_mutex_init( &scsi_task->uplink_mutex, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_scsi_emu_io_block_read: Error while initializing DNBD3 uplink mutex for iSCSI SCSI task" ); - - return -ENOMEM; - } - - if ( pthread_cond_init( &scsi_task->uplink_cond, NULL ) != 0 ) { - logadd( LOG_ERROR, "iscsi_scsi_emu_io_block_read: Error while initializing DNBD3 uplink condition for iSCSI SCSI task" ); + if ( !uplink_request( image, scsi_task, iscsi_uplink_callback, 0, offset_bytes, num_bytes ) ) { + pthread_mutex_unlock( &scsi_task->uplink_mutex ); - pthread_mutex_destroy( &scsi_task->uplink_mutex ); + logadd( LOG_DEBUG1, "Could not relay uncached request to upstream proxy for image %s:%d", + image->name, image->rid ); - return -ENOMEM; + return -EIO; } - pthread_mutex_lock( &scsi_task->uplink_mutex ); - success = uplink_request( image, (void *) scsi_task, iscsi_uplink_callback, 0ULL, offset_bytes, (uint32_t) num_bytes ); - - if ( success ) - pthread_cond_wait( &scsi_task->uplink_cond, &scsi_task->uplink_mutex ); - + // Wait sync (Maybe use pthread_cond_timedwait to detect unavailable uplink instead of hanging...) + pthread_cond_wait( &scsi_task->uplink_cond, &scsi_task->uplink_mutex ); pthread_mutex_unlock( &scsi_task->uplink_mutex ); pthread_cond_destroy( &scsi_task->uplink_cond ); pthread_mutex_destroy( &scsi_task->uplink_mutex ); } } + bool success; + if ( readFromFile ) { const int64_t len = pread( image->readFd, scsi_task->buf, (size_t) num_bytes, offset_bytes ); success = ((uint64_t) len == num_bytes); + } else { + success = true; } - iscsi_connection_exec_queue *exec_queue = (iscsi_connection_exec_queue *) malloc( sizeof(struct iscsi_connection_exec_queue) ); - - if ( exec_queue == NULL ) { - logadd( LOG_ERROR, "iscsi_scsi_emu_io_block_read: Out of memory while allocating execution queue for I/O read" ); - - return -ENOMEM; - } - - exec_queue->data.io.callback = callback; - exec_queue->data.io.image = image; - exec_queue->data.io.user_data = user_data; - exec_queue->data.io.success = success; - exec_queue->type = ISCSI_CONNECT_EXEC_QUEUE_TYPE_SCSI_EMU_IO; - - iscsi_task *task = ISCSI_CONTAINER(iscsi_task, scsi_task, scsi_task); - - iscsi_list_enqueue( &task->conn->exec_queue, &exec_queue->node ); - - return (success ? 0 : -EIO); -} - -/** - * @brief Completes an iSCSI SCSI task after a finished I/O read operation. - * - * THis function also sets the SCSI status - * and error code as required. - * - * @param[in] image Pointer to DNBD3 image where - * the I/O read operation occured and - * may NOT be NULL, so be careful. - * @param[in] user_data Pointer to the iSCSI SCSI task - * responsible for this I/O operation. - * NULL is NOT allowed here, so take - * caution. - * @param[in] success true if the I/O operation has been - * completed successfully, false otherwise. - * @return Pointer to passed user data. - */ -uint8_t *iscsi_scsi_emu_block_read_complete_callback(dnbd3_image_t *image, uint8_t *user_data, const bool success) -{ - iscsi_scsi_task *scsi_task = (iscsi_scsi_task *) user_data; - if ( success ) scsi_task->status = ISCSI_SCSI_STATUS_GOOD; else iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_MEDIUM_ERR, ISCSI_SCSI_ASC_UNRECOVERED_READ_ERR, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - iscsi_scsi_lun_task_complete( scsi_task->lun, scsi_task ); - - return user_data; -} - -/** - * @brief Compares and writes a number of blocks starting from a block offset in a DNBD3 image with specified buffers. - * - * This function enqueues the I/O compare - * and write process which invokes a - * callback function when the compare and - * write operation has been finished. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task which - * executes the I/O compare and write - * operation, may NOT be NULL, so be - * careful. - * @param[in] cmp_buf Pointer to buffer which contains - * the data to be compared and may NOT - * be NULL, so be careful. - * @param[in] image Pointer to DNBD3 image to write - * data to. NULL is an illegal value, - * take caution. - * @param[in] offset_blocks Offset in blocks to start writing to. - * @param[in] num_blocks Number of blocks to write. - * @param[in] block_size Block size in bytes. - * @param[in] callback Pointer to callback function to invoke - * after I/O compare and write operation - * has been finished. NULL is a - * prohibited value, so be careful. - * @param[in] user_data Pointer to user data passed to the - * callback function. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -int iscsi_scsi_emu_io_block_cmp_write(iscsi_scsi_task *scsi_task, uint8_t *cmp_buf, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks, const uint32_t block_size, iscsi_scsi_emu_io_complete_callback callback, uint8_t *user_data) -{ - // TODO: Implement compare and write I/O. - - return ISCSI_SCSI_TASK_RUN_COMPLETE; -} - -/** - * @brief Completes an iSCSI SCSI task after a finished I/O write operation. - * - * THis function also sets the SCSI status - * and error code as required. - * - * @param[in] image Pointer to DNBD3 image where - * the I/O write operation occured and - * may NOT be NULL, so be careful. - * @param[in] user_data Pointer to the iSCSI SCSI task - * responsible for this I/O operation. - * NULL is NOT allowed here, so take - * caution. - * @param[in] success true if the I/O operation has been - * completed successfully, false otherwise. - * @return Pointer to passed user data. - */ -uint8_t *iscsi_scsi_emu_block_write_complete_callback(dnbd3_image_t *image, uint8_t *user_data, const bool success) -{ - iscsi_scsi_task *scsi_task = (iscsi_scsi_task *) user_data; - - free( scsi_task->buf ); - scsi_task->buf = NULL; - - if ( success ) - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - else - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_MEDIUM_ERR, ISCSI_SCSI_ASC_WRITE_ERR, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - iscsi_scsi_lun_task_complete( scsi_task->lun, scsi_task ); - - return user_data; -} - -/** - * @brief Writes a number of blocks from a block offset to a DNBD3 image of a specified buffer. - * - * This function enqueues the I/O write - * process which invokes a callback - * function when the write operation - * has been finished. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task which - * executes the I/O write operation, may - * NOT be NULL, so be careful. - * @param[in] image Pointer to DNBD3 image to write - * data to and may NOT be NULL, so - * be careful. - * @param[in] offset_blocks Offset in blocks to start writing to. - * @param[in] num_blocks Number of blocks to write. - * @param[in] block_size Block size in bytes. - * @param[in] callback Pointer to callback function to invoke - * after I/O write operation has been - * finished. NULL is a prohibited - * value, so be careful. - * @param[in] user_data Pointer to user data passed to the - * callback function. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -int iscsi_scsi_emu_io_block_write(iscsi_scsi_task *scsi_task, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks, const uint32_t block_size, iscsi_scsi_emu_io_complete_callback callback, uint8_t *user_data) -{ - uint64_t offset_bytes; - const uint64_t num_bytes = iscsi_scsi_emu_blocks_to_bytes( &offset_bytes, offset_blocks, num_blocks, block_size ); - const int64_t len = pwrite( image->readFd, scsi_task->buf, (size_t) num_bytes, offset_bytes ); - const bool success = ((uint64_t) len == num_bytes); - iscsi_connection_exec_queue *exec_queue = (iscsi_connection_exec_queue *) malloc( sizeof(struct iscsi_connection_exec_queue) ); - - if ( exec_queue == NULL ) { - logadd( LOG_ERROR, "iscsi_scsi_emu_io_block_read: Out of memory while allocating execution queue for I/O write" ); - - return -ENOMEM; - } - - exec_queue->data.io.callback = callback; - exec_queue->data.io.image = image; - exec_queue->data.io.user_data = user_data; - exec_queue->data.io.success = success; - exec_queue->type = ISCSI_CONNECT_EXEC_QUEUE_TYPE_SCSI_EMU_IO; - - iscsi_task *task = ISCSI_CONTAINER(iscsi_task, scsi_task, scsi_task); - - iscsi_list_enqueue( &task->conn->exec_queue, &exec_queue->node ); - - return (success ? 0 : -EIO); + return (success ? 0 : -1); } /** @@ -5577,15 +1071,21 @@ static int iscsi_scsi_emu_block_read_write(dnbd3_image_t *image, iscsi_scsi_task { scsi_task->xfer_pos = 0UL; + if ( (flags & ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE) != 0 ) { + iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); + + return ISCSI_SCSI_TASK_RUN_COMPLETE; + } + if ( (scsi_task->flags & (ISCSI_SCSI_TASK_FLAGS_XFER_READ | ISCSI_SCSI_TASK_FLAGS_XFER_WRITE)) == (ISCSI_SCSI_TASK_FLAGS_XFER_READ | ISCSI_SCSI_TASK_FLAGS_XFER_WRITE) ) { iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); return ISCSI_SCSI_TASK_RUN_COMPLETE; } - const uint64_t block_count = iscsi_scsi_emu_block_get_count( image ); + const uint64_t imgBlockCount = iscsi_scsi_emu_block_get_count( image ); - if ( (block_count <= lba) || ((block_count - lba) < xfer_len) ) { + if ( (imgBlockCount <= lba) || ((imgBlockCount - lba) < xfer_len) ) { iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_LOGICAL_BLOCK_ADDRESS_OUT_OF_RANGE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); return ISCSI_SCSI_TASK_RUN_COMPLETE; @@ -5597,14 +1097,7 @@ static int iscsi_scsi_emu_block_read_write(dnbd3_image_t *image, iscsi_scsi_task return ISCSI_SCSI_TASK_RUN_COMPLETE; } - const uint32_t block_size = iscsi_scsi_emu_block_get_size( image ); - const bool block_size_pow2 = iscsi_is_pow2( block_size ); - uint32_t block_size_shift; - - if ( block_size_pow2 ) - block_size_shift = iscsi_scsi_emu_block_get_size_shift( image ); - - const uint32_t max_xfer_len = (block_size_pow2 ? (ISCSI_SCSI_EMU_MAX_XFER_LEN >> block_size_shift) : (ISCSI_SCSI_EMU_MAX_XFER_LEN / block_size)); + const uint32_t max_xfer_len = ISCSI_MAX_DS_SIZE / ISCSI_SCSI_EMU_BLOCK_SIZE; if ( xfer_len > max_xfer_len ) { iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_FIELD_IN_CDB, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); @@ -5612,16 +1105,10 @@ static int iscsi_scsi_emu_block_read_write(dnbd3_image_t *image, iscsi_scsi_task return ISCSI_SCSI_TASK_RUN_COMPLETE; } - if ( ((flags & ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE) != 0) && ((block_size_pow2 ? (xfer_len << block_size_shift) : (xfer_len * block_size)) > scsi_task->xfer_len) ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - } - uint64_t offset_blocks; uint64_t num_blocks; - if ( iscsi_scsi_emu_bytes_to_blocks( &offset_blocks, &num_blocks, scsi_task->pos, scsi_task->len, block_size ) != 0ULL ) { + if ( iscsi_scsi_emu_bytes_to_blocks( &offset_blocks, &num_blocks, scsi_task->pos, scsi_task->len ) != 0ULL ) { iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); return ISCSI_SCSI_TASK_RUN_COMPLETE; @@ -5631,39 +1118,23 @@ static int iscsi_scsi_emu_block_read_write(dnbd3_image_t *image, iscsi_scsi_task int rc; - if ( (flags & ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE) == 0 ) { - scsi_task->buf = (uint8_t *) malloc( scsi_task->len ); - - if ( scsi_task->buf == NULL ) { - iscsi_scsi_emu_queue_io_wait( scsi_task, iscsi_scsi_emu_block_resubmit_process_callback, (uint8_t *) scsi_task ); + scsi_task->buf = (uint8_t *) malloc( scsi_task->len ); - return ISCSI_SCSI_TASK_RUN_PENDING; - } - - rc = iscsi_scsi_emu_io_block_read( scsi_task, image, offset_blocks, num_blocks, block_size, iscsi_scsi_emu_block_read_complete_callback, (uint8_t *) scsi_task ); - } else if ( iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_PHYSICAL_READ_ONLY ) || iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_WRITE_PROTECT ) ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_DATA_PROTECT, ISCSI_SCSI_ASC_WRITE_PROTECTED, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); + if ( scsi_task->buf == NULL ) { + iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_HARDWARE_ERR, + ISCSI_SCSI_ASC_INTERNAL_TARGET_FAIL, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE ); return ISCSI_SCSI_TASK_RUN_COMPLETE; - } else if ( (flags & ISCSI_SCSI_EMU_BLOCK_FLAGS_VERIFY) != 0 ) { - if ( scsi_task->len != (block_size + block_size) ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_FIELD_IN_CDB, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - } - - uint8_t *cmp_buf = (scsi_task->buf + block_size); - - rc = iscsi_scsi_emu_io_block_cmp_write( scsi_task, cmp_buf, image, offset_blocks, 1ULL, block_size, iscsi_scsi_emu_block_write_complete_callback, (uint8_t *) scsi_task ); - } else { - rc = iscsi_scsi_emu_io_block_write( scsi_task, image, offset_blocks, num_blocks, block_size, iscsi_scsi_emu_block_write_complete_callback, (uint8_t *) scsi_task ); } + rc = iscsi_scsi_emu_io_blocks_read( scsi_task, image, offset_blocks, num_blocks ); + if ( rc < 0 ) { if ( rc == -ENOMEM ) { - iscsi_scsi_emu_queue_io_wait( scsi_task, iscsi_scsi_emu_block_resubmit_process_callback, (uint8_t *) scsi_task ); + iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_HARDWARE_ERR, + ISCSI_SCSI_ASC_INTERNAL_TARGET_FAIL, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE ); - return ISCSI_SCSI_TASK_RUN_PENDING; + return ISCSI_SCSI_TASK_RUN_COMPLETE; } iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); @@ -5673,149 +1144,7 @@ static int iscsi_scsi_emu_block_read_write(dnbd3_image_t *image, iscsi_scsi_task scsi_task->xfer_pos = scsi_task->len; - return ISCSI_SCSI_TASK_RUN_PENDING; -} - -/** - * @brief Enqueues an I/O wait in the thread pool to execute. - * - * This function uses the DNBD3 image - * name in order to identify the - * newly created thread. - * - * @param[in] io_wait Pointer to I/O wait structure - * containing the image name, the - * callback function and optional - * user data passed to callback. May - * NOT be NULL, so be careful. - * @retval -1 An error occured during the - * thread enqeue operation. - * @retval 0 The thread has been enqueued - * successfully. - */ -int iscsi_scsi_emu_io_queue(iscsi_scsi_emu_io_wait *io_wait) -{ - return (threadpool_run( (void *(*)(void *)) io_wait->callback, (void *) io_wait->user_data, io_wait->image->name ) ? 0 : -1); -} - -/** - * @brief Executes a cache synchronization operation on a DNBD3 image. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] image Pointer to DNBD3 image to - * synchronize the cache of. May NOT - * be NULL, so be careful. - * @param[in] scsi_task Pointer to iSCSI SCSI task - * responsible for this cache - * synchronization. NULL is NOT - * allowed here, take caution. - * @param[in] lba Logical Block Address (LBA) to start - * cache synchronization with. - * @param[in] xfer_len Synchronization length in logical blocks. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -static int iscsi_scsi_emu_block_sync(dnbd3_image_t *image, iscsi_scsi_task *scsi_task, const uint64_t lba, const uint32_t xfer_len) -{ - // TODO: Implement SCSI emulation for DNBD3 image. - - return 0; -} - -/** - * @brief Executes a unmap operation on a DNBD3 image. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] image Pointer to DNBD3 image to - * unmap. May NOT be NULL, so be - * careful. - * @param[in] scsi_task Pointer to iSCSI SCSI task - * responsible for this unmap - * operation. NULL is NOT allowed - * here, take caution. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -static int iscsi_scsi_emu_block_unmap(dnbd3_image_t *image, iscsi_scsi_task *scsi_task) -{ - // TODO: Implement SCSI emulation for DNBD3 image. - - return 0; -} - -/** - * @brief Executes a write same operation on a DNBD3 image. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] image Pointer to DNBD3 image to write - * to. May NOT be NULL, so be - * careful. - * @param[in] scsi_task Pointer to iSCSI SCSI task - * responsible for this write task. - * NULL is NOT allowed here, take - * caution. - * @param[in] lba Logical Block Address (LBA) to start - * writing to. - * @param[in] xfer_len Transfer length in logical blocks. - * @param[in] flags SCSI (Command Descriptor Block) CDB flags. - * @return 0 on successful operation, a negative - * error code otherwise. - */ -static int iscsi_scsi_emu_block_write_same(dnbd3_image_t *image, iscsi_scsi_task *scsi_task, const uint64_t lba, const uint32_t xfer_len, const int flags) -{ - // TODO: Implement SCSI emulation for DNBD3 image. - - return 0; -} - -/** - * @brief Initializes a DNBD3 image for an iSCSI SCSI LUN retrieved from its iSCSI SCSI task and optionally check for read access. - * - * This function also sets the SCSI - * status result code accordingly. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task - * to retrieve the iSCSI SCSI LUN - * from in order to initialize the - * DNBD3 image and also set the SCSI - * error code. May NOT be NULL, so - * be careful. - * @param[in] access Check if read access for DNBD3 - * image is working. - * @retval true The DNBD3 image has been initialized - * successfully and is readable. - * @retval false The DNBD3 image has NOT been - * successfully and reading is not possible. - */ -static bool iscsi_scsi_emu_image_init(iscsi_scsi_task *scsi_task, const bool access) -{ - // TODO: Handle server and proxy stuff. - - iscsi_scsi_lun *lun = scsi_task->lun; - - if ( lun->image == NULL ) { - lun->image = image_getOrLoad( (char *) lun->device->name, (uint16_t) lun->id ); - - if ( lun->image == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NOT_READY, ISCSI_SCSI_ASC_LOGICAL_UNIT_NOT_READY, ISCSI_SCSI_ASCQ_MANUAL_INTERVENTION_REQUIRED ); - - return false; - } - } - - if ( access && (!image_ensureOpen( lun->image ) || lun->image->problem.read || (lun->image->virtualFilesize == 0ULL)) ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NOT_READY, ISCSI_SCSI_ASC_LOGICAL_UNIT_NOT_READY, ISCSI_SCSI_ASCQ_MANUAL_INTERVENTION_REQUIRED ); - - return false; - } - - return true; + return ISCSI_SCSI_TASK_RUN_COMPLETE; } /** @@ -5832,150 +1161,47 @@ static bool iscsi_scsi_emu_image_init(iscsi_scsi_task *scsi_task, const bool acc */ static int iscsi_scsi_emu_block_process(iscsi_scsi_task *scsi_task) { - iscsi_scsi_lun *lun = scsi_task->lun; uint64_t lba; uint32_t xfer_len; + dnbd3_image_t *image = scsi_task->connection->client->image; switch ( scsi_task->cdb->opcode ) { case ISCSI_SCSI_OPCODE_READ6 : { const iscsi_scsi_cdb_read_write_6 *cdb_read_write_6 = (iscsi_scsi_cdb_read_write_6 *) scsi_task->cdb; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - lba = iscsi_get_be24(cdb_read_write_6->lba); xfer_len = cdb_read_write_6->xfer_len; if ( xfer_len == 0UL ) xfer_len = 256UL; - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, 0 ); - - break; - } - case ISCSI_SCSI_OPCODE_WRITE6 : { - const iscsi_scsi_cdb_read_write_6 *cdb_read_write_6 = (iscsi_scsi_cdb_read_write_6 *) scsi_task->cdb; - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - lba = iscsi_get_be24(cdb_read_write_6->lba); - xfer_len = cdb_read_write_6->xfer_len; - - if ( xfer_len == 0UL ) - xfer_len = 256UL; - - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE ); - - break; + return iscsi_scsi_emu_block_read_write( image, scsi_task, lba, xfer_len, 0 ); } case ISCSI_SCSI_OPCODE_READ10 : { const iscsi_scsi_cdb_read_write_10 *cdb_read_write_10 = (iscsi_scsi_cdb_read_write_10 *) scsi_task->cdb; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - lba = iscsi_get_be32(cdb_read_write_10->lba); - xfer_len = iscsi_get_be16(cdb_read_write_10->xfer_len); - - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, 0 ); - - break; - } - case ISCSI_SCSI_OPCODE_WRITE10 : { - const iscsi_scsi_cdb_read_write_10 *cdb_read_write_10 = (iscsi_scsi_cdb_read_write_10 *) scsi_task->cdb; - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - lba = iscsi_get_be32(cdb_read_write_10->lba); xfer_len = iscsi_get_be16(cdb_read_write_10->xfer_len); - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE ); - - break; + return iscsi_scsi_emu_block_read_write( image, scsi_task, lba, xfer_len, 0 ); } case ISCSI_SCSI_OPCODE_READ12 : { const iscsi_scsi_cdb_read_write_12 *cdb_read_write_12 = (iscsi_scsi_cdb_read_write_12 *) scsi_task->cdb; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - lba = iscsi_get_be32(cdb_read_write_12->lba); - xfer_len = iscsi_get_be32(cdb_read_write_12->xfer_len); - - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, 0 ); - - break; - } - case ISCSI_SCSI_OPCODE_WRITE12 : { - const iscsi_scsi_cdb_read_write_12 *cdb_read_write_12 = (iscsi_scsi_cdb_read_write_12 *) scsi_task->cdb; - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - lba = iscsi_get_be32(cdb_read_write_12->lba); xfer_len = iscsi_get_be32(cdb_read_write_12->xfer_len); - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE ); - - break; + return iscsi_scsi_emu_block_read_write( image, scsi_task, lba, xfer_len, 0 ); } case ISCSI_SCSI_OPCODE_READ16 : { const iscsi_scsi_cdb_read_write_16 *cdb_read_write_16 = (iscsi_scsi_cdb_read_write_16 *) scsi_task->cdb; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - lba = iscsi_get_be64(cdb_read_write_16->lba); xfer_len = iscsi_get_be32(cdb_read_write_16->xfer_len); - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, 0 ); - - break; - } - case ISCSI_SCSI_OPCODE_WRITE16 : { - const iscsi_scsi_cdb_read_write_16 *cdb_read_write_16 = (iscsi_scsi_cdb_read_write_16 *) scsi_task->cdb; - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - lba = iscsi_get_be64(cdb_read_write_16->lba); - xfer_len = iscsi_get_be32(cdb_read_write_16->xfer_len); - - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE ); - - break; - } - case ISCSI_SCSI_OPCODE_COMPARE_AND_WRITE : { - const iscsi_scsi_cdb_cmp_write *cdb_cmp_write = (iscsi_scsi_cdb_cmp_write *) scsi_task->cdb; - - lba = iscsi_get_be64(cdb_cmp_write->lba); - xfer_len = cdb_cmp_write->num_blocks; - - if ( ((cdb_cmp_write->flags & (ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_FUA | ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_DPO)) != 0) || ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_GET_WRPROTECT(cdb_cmp_write->flags) ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_FIELD_IN_CDB, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - } - - if ( xfer_len != 1UL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_FIELD_IN_CDB, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - } - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - return iscsi_scsi_emu_block_read_write( lun->image, scsi_task, lba, xfer_len, (ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE | ISCSI_SCSI_EMU_BLOCK_FLAGS_VERIFY) ); - - break; + return iscsi_scsi_emu_block_read_write( image, scsi_task, lba, xfer_len, 0 ); } case ISCSI_SCSI_OPCODE_READCAPACITY10 : { - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - iscsi_scsi_read_capacity_10_parameter_data_packet *buf = (iscsi_scsi_read_capacity_10_parameter_data_packet *) malloc( sizeof(struct iscsi_scsi_read_capacity_10_parameter_data_packet) ); if ( buf == NULL ) { @@ -5984,16 +1210,14 @@ static int iscsi_scsi_emu_block_process(iscsi_scsi_task *scsi_task) return ISCSI_SCSI_TASK_RUN_COMPLETE; } - lba = iscsi_scsi_emu_block_get_count( lun->image ) - 1ULL; + lba = iscsi_scsi_emu_block_get_count( image ) - 1ULL; if ( lba > 0xFFFFFFFFULL ) buf->lba = 0xFFFFFFFFUL; // Minus one does not require endianess conversion else iscsi_put_be32( (uint8_t *) &buf->lba, (uint32_t) lba ); - xfer_len = iscsi_scsi_emu_block_get_size( lun->image ); - - iscsi_put_be32( (uint8_t *) &buf->block_len, xfer_len ); + iscsi_put_be32( (uint8_t *) &buf->block_len, ISCSI_SCSI_EMU_BLOCK_SIZE ); uint len = scsi_task->len; @@ -6009,122 +1233,41 @@ static int iscsi_scsi_emu_block_process(iscsi_scsi_task *scsi_task) case ISCSI_SCSI_OPCODE_SERVICE_ACTION_IN_16 : { const iscsi_scsi_cdb_service_action_in_16 *cdb_servce_in_action_16 = (iscsi_scsi_cdb_service_action_in_16 *) scsi_task->cdb; - switch ( ISCSI_SCSI_CDB_SERVICE_ACTION_IN_16_GET_ACTION(cdb_servce_in_action_16->action) ) { - case ISCSI_SCSI_CDB_SERVICE_ACTION_IN_16_ACTION_READ_CAPACITY_16 : { - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - iscsi_scsi_service_action_in_16_parameter_data_packet *buf = (iscsi_scsi_service_action_in_16_parameter_data_packet *) malloc( sizeof(struct iscsi_scsi_service_action_in_16_parameter_data_packet) ); - - if ( buf == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NOT_READY, ISCSI_SCSI_ASC_LOGICAL_UNIT_NOT_READY, ISCSI_SCSI_ASCQ_BECOMING_READY ); - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - } - - lba = iscsi_scsi_emu_block_get_count( lun->image ) - 1ULL; - xfer_len = iscsi_scsi_emu_block_get_size( lun->image ); - - iscsi_put_be64( (uint8_t *) &buf->lba, lba ); - iscsi_put_be32( (uint8_t *) &buf->block_len, xfer_len ); - - buf->flags = 0; - - const uint8_t exponent = (uint8_t) iscsi_scsi_emu_block_get_ratio_shift( lun->image ); - - buf->exponents = ISCSI_SCSI_SERVICE_ACTION_IN_16_PARAM_DATA_PUT_LBPPB_EXPONENT((exponent <= ISCSI_SCSI_SERVICE_ACTION_IN_16_PARAM_DATA_LBPPB_EXPONENT_MASK) ? exponent : 0U); - - if ( iscsi_scsi_emu_io_type_is_supported( lun->image, ISCSI_SCSI_EMU_IO_TYPE_UNMAP ) ) - iscsi_put_be16( (uint8_t *) &buf->lbp_lalba, ISCSI_SCSI_SERVICE_ACTION_IN_16_PARAM_DATA_LBPME ); - else - buf->lbp_lalba = 0U; - - buf->reserved[0] = 0ULL; - buf->reserved[1] = 0ULL; - - uint len = cdb_servce_in_action_16->alloc_len; - - if ( len > sizeof(struct iscsi_scsi_service_action_in_16_parameter_data_packet) ) - len = sizeof(struct iscsi_scsi_service_action_in_16_parameter_data_packet); // TODO: Check whether scatter data is required - - scsi_task->buf = (uint8_t *) buf; - scsi_task->xfer_pos = len; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - - break; - } - default : { - return ISCSI_SCSI_TASK_RUN_UNKNOWN; - - break; - } + if ( ISCSI_SCSI_CDB_SERVICE_ACTION_IN_16_GET_ACTION(cdb_servce_in_action_16->action) + != ISCSI_SCSI_CDB_SERVICE_ACTION_IN_16_ACTION_READ_CAPACITY_16 ) { + return ISCSI_SCSI_TASK_RUN_UNKNOWN; } + iscsi_scsi_service_action_in_16_parameter_data_packet *buf = (iscsi_scsi_service_action_in_16_parameter_data_packet *) malloc( sizeof(struct iscsi_scsi_service_action_in_16_parameter_data_packet) ); - break; - } - case ISCSI_SCSI_OPCODE_SYNCHRONIZECACHE10 : { - const iscsi_scsi_cdb_sync_cache_10 *cdb_sync_cache_10 = (iscsi_scsi_cdb_sync_cache_10 *) scsi_task->cdb; - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - lba = iscsi_get_be32(cdb_sync_cache_10->lba); - xfer_len = iscsi_get_be16(cdb_sync_cache_10->xfer_len); - - if ( xfer_len == 0UL ) - xfer_len = (uint32_t) (iscsi_scsi_emu_block_get_count( lun->image ) - lba); - - return iscsi_scsi_emu_block_sync( lun->image, scsi_task, lba, xfer_len ); - - break; - } - case ISCSI_SCSI_OPCODE_SYNCHRONIZECACHE16 : { - const iscsi_scsi_cdb_sync_cache_16 *cdb_sync_cache_16 = (iscsi_scsi_cdb_sync_cache_16 *) scsi_task->cdb; - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - - lba = iscsi_get_be64(cdb_sync_cache_16->lba); - xfer_len = iscsi_get_be32(cdb_sync_cache_16->xfer_len); - - if ( xfer_len == 0UL ) - xfer_len = (uint32_t) (iscsi_scsi_emu_block_get_count( lun->image ) - lba); - - return iscsi_scsi_emu_block_sync( lun->image, scsi_task, lba, xfer_len ); + if ( buf == NULL ) { + iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NOT_READY, ISCSI_SCSI_ASC_LOGICAL_UNIT_NOT_READY, ISCSI_SCSI_ASCQ_BECOMING_READY ); - break; - } - case ISCSI_SCSI_OPCODE_UNMAP : { - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; + return ISCSI_SCSI_TASK_RUN_COMPLETE; + } - return iscsi_scsi_emu_block_unmap( lun->image, scsi_task ); + lba = iscsi_scsi_emu_block_get_count( image ) - 1ULL; - break; - } - case ISCSI_SCSI_OPCODE_WRITE_SAME10 : { - const iscsi_scsi_cdb_write_same_10 *cdb_write_same_10 = (iscsi_scsi_cdb_write_same_10 *) scsi_task->cdb; + iscsi_put_be64( (uint8_t *) &buf->lba, lba ); + iscsi_put_be32( (uint8_t *) &buf->block_len, ISCSI_SCSI_EMU_BLOCK_SIZE ); - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; + buf->flags = 0; - lba = iscsi_get_be32(cdb_write_same_10->lba); - xfer_len = iscsi_get_be16(cdb_write_same_10->xfer_len); + const uint8_t exponent = ISCSI_SCSI_EMU_BLOCK_DIFF_SHIFT; - return iscsi_scsi_emu_block_write_same( lun->image, scsi_task, lba, xfer_len, cdb_write_same_10->flags ); + buf->exponents = ISCSI_SCSI_SERVICE_ACTION_IN_16_PARAM_DATA_PUT_LBPPB_EXPONENT((exponent <= ISCSI_SCSI_SERVICE_ACTION_IN_16_PARAM_DATA_LBPPB_EXPONENT_MASK) ? exponent : 0U); - break; - } - case ISCSI_SCSI_OPCODE_WRITE_SAME16 : { - const iscsi_scsi_cdb_write_same_16 *cdb_write_same_16 = (iscsi_scsi_cdb_write_same_16 *) scsi_task->cdb; + buf->lbp_lalba = 0U; + buf->reserved[0] = 0ULL; + buf->reserved[1] = 0ULL; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; + uint len = cdb_servce_in_action_16->alloc_len; - lba = iscsi_get_be64(cdb_write_same_16->lba); - xfer_len = iscsi_get_be32(cdb_write_same_16->xfer_len); + if ( len > sizeof(struct iscsi_scsi_service_action_in_16_parameter_data_packet) ) + len = sizeof(struct iscsi_scsi_service_action_in_16_parameter_data_packet); // TODO: Check whether scatter data is required - return iscsi_scsi_emu_block_write_same( lun->image, scsi_task, lba, xfer_len, cdb_write_same_16->flags ); + scsi_task->buf = (uint8_t *) buf; + scsi_task->xfer_pos = len; + scsi_task->status = ISCSI_SCSI_STATUS_GOOD; break; } @@ -6139,29 +1282,6 @@ static int iscsi_scsi_emu_block_process(iscsi_scsi_task *scsi_task) } /** - * @brief Resubmits an iSCSI SCSI task for execution. - * - * This function is invoked if an iSCSI - * SCSI task needs to be resubmitted in - * case if a prior execution failed and - * the failure is recoverable. - * - * @param[in] user_data Pointer to user_data which is - * the iSCSI SCSI task to be executed - * again. May NOT be NULL, so be - * careful. - * @return Pointer to passed user data. - */ -uint8_t *iscsi_scsi_emu_block_resubmit_process_callback(uint8_t *user_data) -{ - iscsi_scsi_task *scsi_task = (iscsi_scsi_task *) user_data; - - iscsi_scsi_emu_block_process( scsi_task ); - - return user_data; -} - -/** * @brief Checks whether provided SCSI CDB allocation length is large enough. * * This function also sets the SCSI @@ -6230,73 +1350,6 @@ static size_t iscsi_scsi_emu_pad_scsi_name(uint8_t *buf, const uint8_t *name) } /** - * @brief Fills in a single Vital Product Data (VPD) SCSI Port Designation Descriptor entry of an INQUIRY operation. - * - * Callback function for each element while iterating - * through the iSCSI SCSI device ports hash map.\n - * The iteration process is aborted when the - * remaining allocation length is not enough - * to hold the current VPD SCSI Port Designation - * Descriptor. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL creates an - * empty key assignment. - * @param[in,out] user_data Pointer to a data structure - * containing the current Vital Product Data - * (VPD) SCSI Port Designation Descriptor - * entry, the total length of all VPD SCSI Port - * Designation Descriptor entries in bytes, the - * remaining allocation length in bytes. May - * NOT be NULL, so be careful. - * @retval -1 Operation failure, ran out of - * allocation space during traversal. - * @retval 0 Successful operation, there is enough - * allocation space to store this - * reported Vital Product Data (VPD) SCSI Port - * Designation Descriptor entry. - */ -int iscsi_scsi_emu_primary_inquiry_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_scsi_emu_primary_inquiry_ports_fill *port_report_fill = (iscsi_scsi_emu_primary_inquiry_ports_fill *) user_data; - iscsi_port *port = (iscsi_port *) value; - - if ( (port->flags & ISCSI_PORT_FLAGS_IN_USE) == 0 ) - return 0; - - const uint port_name_len = (uint) (strlen( (char *) port->name ) + 1U); - const uint len = (uint) (sizeof(struct iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_scsi_target_port_design_dec_inquiry_data_packet) + ISCSI_ALIGN(port_name_len, ISCSI_ALIGN_SIZE)); - - port_report_fill->len -= len; - - if ( (int) port_report_fill->len < 0 ) - return -1; - - iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet *vpd_scsi_port_design_desc_inquiry_data_pkt = port_report_fill->port_entry; - - vpd_scsi_port_design_desc_inquiry_data_pkt->reserved = 0U; - iscsi_put_be16( (uint8_t *) &vpd_scsi_port_design_desc_inquiry_data_pkt->rel_port_id, port->index ); - vpd_scsi_port_design_desc_inquiry_data_pkt->reserved2 = 0U; - vpd_scsi_port_design_desc_inquiry_data_pkt->init_port_len = 0U; - vpd_scsi_port_design_desc_inquiry_data_pkt->reserved3 = 0U; - iscsi_put_be16( (uint8_t *) &vpd_scsi_port_design_desc_inquiry_data_pkt->target_desc_len, (uint16_t) (len - sizeof(struct iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet)) ); - - iscsi_scsi_vpd_scsi_target_port_design_dec_inquiry_data_packet *vpd_scsi_target_port_design_desc_inquiry_data_pkt = vpd_scsi_port_design_desc_inquiry_data_pkt->target_desc; - - vpd_scsi_target_port_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_ISCSI) | ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_UTF8); - vpd_scsi_target_port_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_SCSI_NAME) | ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_TARGET_PORT) | ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); - vpd_scsi_target_port_design_desc_inquiry_data_pkt->reserved = 0U; - vpd_scsi_target_port_design_desc_inquiry_data_pkt->len = (uint8_t) iscsi_scsi_emu_pad_scsi_name( vpd_scsi_target_port_design_desc_inquiry_data_pkt->design, port->name ); - - port_report_fill->port_entry = (iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet *) (((uint8_t *) vpd_scsi_port_design_desc_inquiry_data_pkt) + len); - port_report_fill->alloc_len += len; - - return 0; -} - -/** * @brief Executes an inquiry operation on a DNBD3 image. * * This function also sets the SCSI @@ -6339,19 +1392,10 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task return -1; } - iscsi_scsi_lun *lun = scsi_task->lun; - iscsi_device *device = lun->device; - iscsi_port *port = scsi_task->target_port; - if ( evpd != 0 ) { iscsi_scsi_vpd_page_inquiry_data_packet *vpd_page_inquiry_data_pkt = (iscsi_scsi_vpd_page_inquiry_data_packet *) std_inquiry_data_pkt; - int32_t scsi_device_type = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_DEVICE_TYPE ); uint alloc_len; - - if ( scsi_device_type < 0L ) - scsi_device_type = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_DEVICE_TYPE ); - - const uint8_t pti = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PUT_PERIPHERAL_TYPE(scsi_device_type) | ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PUT_PERIPHERAL_ID(ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PERIPHERAL_ID_POSSIBLE); + const uint8_t pti = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PUT_PERIPHERAL_TYPE(ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PERIPHERAL_TYPE_DIRECT) | ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PUT_PERIPHERAL_ID(ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PERIPHERAL_ID_POSSIBLE); vpd_page_inquiry_data_pkt->peripheral_type_id = pti; vpd_page_inquiry_data_pkt->page_code = (uint8_t) pc; @@ -6361,20 +1405,11 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task vpd_page_inquiry_data_pkt->params[0] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_SUPPORTED_VPD_PAGES; vpd_page_inquiry_data_pkt->params[1] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_UNIT_SERIAL_NUMBER; vpd_page_inquiry_data_pkt->params[2] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_DEVICE_ID; - vpd_page_inquiry_data_pkt->params[3] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_MANAGEMENT_NETWORK_ADDRS; - vpd_page_inquiry_data_pkt->params[4] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_EXTENDED_INQUIRY_DATA; - vpd_page_inquiry_data_pkt->params[5] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_MODE_PAGE_POLICY; - vpd_page_inquiry_data_pkt->params[6] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_SCSI_PORTS; - vpd_page_inquiry_data_pkt->params[7] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_BLOCK_LIMITS; - vpd_page_inquiry_data_pkt->params[8] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_BLOCK_DEV_CHARS; + vpd_page_inquiry_data_pkt->params[3] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_EXTENDED_INQUIRY_DATA; + vpd_page_inquiry_data_pkt->params[4] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_BLOCK_LIMITS; + vpd_page_inquiry_data_pkt->params[5] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_BLOCK_DEV_CHARS; - alloc_len = 9U; - - if ( iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_UNMAP ) ) { - vpd_page_inquiry_data_pkt->params[9] = ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_THIN_PROVISION; - - alloc_len++; - } + alloc_len = 6U; iscsi_put_be16( (uint8_t *) &vpd_page_inquiry_data_pkt->alloc_len, (uint16_t) alloc_len ); @@ -6398,8 +1433,9 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task break; } case ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_DEVICE_ID : { - const uint dev_name_len = (uint) (strlen( (char *) device->name ) + 1U); - const uint port_name_len = (uint) (strlen( (char *) port->name ) + 1U); + const char *port_name = "Horst"; + const uint dev_name_len = (uint) (strlen( image->name ) + 1U); + const uint port_name_len = (uint) (strlen( port_name ) + 1U); alloc_len = (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_ieee_naa_ext_inquiry_data_packet)); // 64-bit IEEE NAA Extended alloc_len += (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_t10_vendor_id_inquiry_data_packet)); // T10 Vendor ID @@ -6417,7 +1453,7 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *vpd_page_design_desc_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *) vpd_page_inquiry_data_pkt->params; - vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(device->protocol_id); + vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_DEFAULT_PROTOCOL_ID); vpd_page_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_NAA) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LOGICAL_UNIT) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); vpd_page_design_desc_inquiry_data_pkt->reserved = 0U; vpd_page_design_desc_inquiry_data_pkt->len = sizeof(struct iscsi_scsi_vpd_page_design_desc_ieee_naa_ext_inquiry_data_packet); @@ -6427,7 +1463,7 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task alloc_len = (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_ieee_naa_ext_inquiry_data_packet)); vpd_page_design_desc_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *) (((uint8_t *) vpd_page_design_desc_inquiry_data_pkt) + alloc_len); - vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_ASCII) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(device->protocol_id); + vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_ASCII) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_DEFAULT_PROTOCOL_ID); vpd_page_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_T10_VENDOR_ID) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LOGICAL_UNIT) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); vpd_page_design_desc_inquiry_data_pkt->reserved = 0U; vpd_page_design_desc_inquiry_data_pkt->len = sizeof(struct iscsi_scsi_vpd_page_design_desc_t10_vendor_id_inquiry_data_packet); @@ -6441,23 +1477,23 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task alloc_len += (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_t10_vendor_id_inquiry_data_packet)); vpd_page_design_desc_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *) (((uint8_t *) vpd_page_design_desc_inquiry_data_pkt) + (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_t10_vendor_id_inquiry_data_packet))); - vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_UTF8) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(device->protocol_id); + vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_UTF8) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_DEFAULT_PROTOCOL_ID); vpd_page_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_SCSI_NAME) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_TARGET_DEVICE) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); vpd_page_design_desc_inquiry_data_pkt->reserved = 0U; - vpd_page_design_desc_inquiry_data_pkt->len = (uint8_t) iscsi_scsi_emu_pad_scsi_name( vpd_page_design_desc_inquiry_data_pkt->desc, device->name ); + vpd_page_design_desc_inquiry_data_pkt->len = (uint8_t) iscsi_scsi_emu_pad_scsi_name( vpd_page_design_desc_inquiry_data_pkt->desc, (const uint8_t*)image->name ); alloc_len += (uint) (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + vpd_page_design_desc_inquiry_data_pkt->len); vpd_page_design_desc_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *) (((uint8_t *) vpd_page_design_desc_inquiry_data_pkt) + (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + vpd_page_design_desc_inquiry_data_pkt->len)); - vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_UTF8) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(device->protocol_id); + vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_UTF8) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_DEFAULT_PROTOCOL_ID); vpd_page_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_SCSI_NAME) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_TARGET_PORT) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); vpd_page_design_desc_inquiry_data_pkt->reserved = 0U; - vpd_page_design_desc_inquiry_data_pkt->len = (uint8_t) iscsi_scsi_emu_pad_scsi_name( vpd_page_design_desc_inquiry_data_pkt->desc, port->name ); + vpd_page_design_desc_inquiry_data_pkt->len = (uint8_t) iscsi_scsi_emu_pad_scsi_name( vpd_page_design_desc_inquiry_data_pkt->desc, (const uint8_t*)port_name ); alloc_len += (uint) (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + vpd_page_design_desc_inquiry_data_pkt->len); vpd_page_design_desc_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *) (((uint8_t *) vpd_page_design_desc_inquiry_data_pkt) + (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + vpd_page_design_desc_inquiry_data_pkt->len)); - vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(device->protocol_id); + vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_DEFAULT_PROTOCOL_ID); vpd_page_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_REL_TARGET_PORT) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_TARGET_PORT) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); vpd_page_design_desc_inquiry_data_pkt->reserved = 0U; vpd_page_design_desc_inquiry_data_pkt->len = sizeof(struct iscsi_scsi_vpd_page_design_desc_rel_target_port_inquiry_data_packet); @@ -6465,12 +1501,12 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task iscsi_scsi_vpd_page_design_desc_rel_target_port_inquiry_data_packet *vpd_page_design_desc_rel_target_port_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_rel_target_port_inquiry_data_packet *) vpd_page_design_desc_inquiry_data_pkt->desc; vpd_page_design_desc_rel_target_port_inquiry_data_pkt->reserved = 0U; - iscsi_put_be16( (uint8_t *) &vpd_page_design_desc_rel_target_port_inquiry_data_pkt->index, port->index ); + iscsi_put_be16( (uint8_t *) &vpd_page_design_desc_rel_target_port_inquiry_data_pkt->index, 1 ); alloc_len += (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_rel_target_port_inquiry_data_packet)); vpd_page_design_desc_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *) (((uint8_t *) vpd_page_design_desc_inquiry_data_pkt) + (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_rel_target_port_inquiry_data_packet))); - vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(device->protocol_id); + vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_DEFAULT_PROTOCOL_ID); vpd_page_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_TARGET_PORT_GROUP) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_TARGET_PORT) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); vpd_page_design_desc_inquiry_data_pkt->reserved = 0U; vpd_page_design_desc_inquiry_data_pkt->len = sizeof(struct iscsi_scsi_vpd_page_design_desc_target_port_group_inquiry_data_packet); @@ -6483,15 +1519,15 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task alloc_len += (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_target_port_group_inquiry_data_packet)); vpd_page_design_desc_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_inquiry_data_packet *) (((uint8_t *) vpd_page_design_desc_inquiry_data_pkt) + (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_target_port_group_inquiry_data_packet))); - vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(device->protocol_id); + vpd_page_design_desc_inquiry_data_pkt->protocol_id_code_set = ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(ISCSI_DEFAULT_PROTOCOL_ID); vpd_page_design_desc_inquiry_data_pkt->flags = (int8_t) (ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_LOGICAL_UNIT_GROUP) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LOGICAL_UNIT) | ISCSI_SCSI_VPD_PAGE_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV); vpd_page_design_desc_inquiry_data_pkt->reserved = 0U; vpd_page_design_desc_inquiry_data_pkt->len = sizeof(struct iscsi_scsi_vpd_page_design_desc_logical_unit_group_inquiry_data_packet); - iscsi_scsi_vpd_page_design_desc_logical_unit_group_inquiry_data_packet *vpd_page_design_desc_logical_unit_group_inquiry_data_pkt = (iscsi_scsi_vpd_page_design_desc_logical_unit_group_inquiry_data_packet *) vpd_page_design_desc_inquiry_data_pkt->desc; + iscsi_scsi_vpd_page_design_desc_logical_unit_group_inquiry_data_packet *vpd_page_design_desc_logical_unit_group_inquiry_data_pkt = vpd_page_design_desc_inquiry_data_pkt->desc; vpd_page_design_desc_logical_unit_group_inquiry_data_pkt->reserved = 0U; - iscsi_put_be16( (uint8_t *) &vpd_page_design_desc_logical_unit_group_inquiry_data_pkt->id, (uint16_t) device->id ); + iscsi_put_be16( (uint8_t *) &vpd_page_design_desc_logical_unit_group_inquiry_data_pkt->id, (uint16_t) ISCSI_DEFAULT_DEVICE_ID ); alloc_len += (sizeof(struct iscsi_scsi_vpd_page_design_desc_inquiry_data_packet) + sizeof(struct iscsi_scsi_vpd_page_design_desc_logical_unit_group_inquiry_data_packet)); @@ -6531,43 +1567,6 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task break; } - case ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_MANAGEMENT_NETWORK_ADDRS : { - alloc_len = 0U; - - vpd_page_inquiry_data_pkt->alloc_len = 0U; - - break; - } - case ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_MODE_PAGE_POLICY : { - iscsi_scsi_vpd_mode_page_policy_desc_inquiry_data_packet *vpd_page_mode_page_policy_desc_inquiry_data_pkt = (iscsi_scsi_vpd_mode_page_policy_desc_inquiry_data_packet *) vpd_page_inquiry_data_pkt->params; - - alloc_len = sizeof(struct iscsi_scsi_vpd_mode_page_policy_desc_inquiry_data_packet); - - vpd_page_mode_page_policy_desc_inquiry_data_pkt->page_code = ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_MASK; - vpd_page_mode_page_policy_desc_inquiry_data_pkt->sub_page_code = 0xFFU; - vpd_page_mode_page_policy_desc_inquiry_data_pkt->flags = 0U; - vpd_page_mode_page_policy_desc_inquiry_data_pkt->reserved = 0U; - - iscsi_put_be16( (uint8_t *) &vpd_page_inquiry_data_pkt->alloc_len, (uint16_t) alloc_len ); - - break; - } - case ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_SCSI_PORTS : { - iscsi_scsi_emu_primary_inquiry_ports_fill port_report_fill = {(iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet *) vpd_page_inquiry_data_pkt->params, 0U, (uint) (len - sizeof(struct iscsi_scsi_vpd_page_inquiry_data_packet))}; - const int rc = iscsi_hashmap_iterate( device->ports, iscsi_scsi_emu_primary_inquiry_callback, (uint8_t *) &port_report_fill ); - - if ( rc < 0 ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_FIELD_IN_CDB, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return -1; - } - - alloc_len = port_report_fill.alloc_len; - - iscsi_put_be16( (uint8_t *) &vpd_page_inquiry_data_pkt->alloc_len, (uint16_t) alloc_len ); - - break; - } case ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_BLOCK_LIMITS : { iscsi_scsi_vpd_page_block_limits_inquiry_data_packet *vpd_page_block_limits_inquiry_data_pkt = (iscsi_scsi_vpd_page_block_limits_inquiry_data_packet *) vpd_page_inquiry_data_pkt->params; @@ -6581,30 +1580,17 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task vpd_page_block_limits_inquiry_data_pkt->flags = 0; - uint32_t blocks = (ISCSI_SCSI_EMU_MAX_XFER_LEN >> iscsi_scsi_emu_block_get_size_shift( image )); - - if ( blocks > 255UL ) - blocks = 255UL; + uint32_t blocks = (ISCSI_MAX_DS_SIZE / ISCSI_SCSI_EMU_BLOCK_SIZE); vpd_page_block_limits_inquiry_data_pkt->max_cmp_write_len = (uint8_t) blocks; - uint32_t optimal_blocks = ISCSI_SCSI_EMU_BLOCK_SIZE >> iscsi_scsi_emu_block_get_size_shift( image ); - - if ( optimal_blocks == 0UL ) - optimal_blocks = 1UL; - - iscsi_put_be16( (uint8_t *) &vpd_page_block_limits_inquiry_data_pkt->optimal_granularity_xfer_len, (uint16_t) optimal_blocks ); + iscsi_put_be16( (uint8_t *) &vpd_page_block_limits_inquiry_data_pkt->optimal_granularity_xfer_len, (uint16_t) blocks ); iscsi_put_be32( (uint8_t *) &vpd_page_block_limits_inquiry_data_pkt->max_xfer_len, blocks ); iscsi_put_be32( (uint8_t *) &vpd_page_block_limits_inquiry_data_pkt->optimal_xfer_len, blocks ); vpd_page_block_limits_inquiry_data_pkt->max_prefetch_len = 0UL; - if ( iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_UNMAP ) ) { - iscsi_put_be32( (uint8_t *) &vpd_page_block_limits_inquiry_data_pkt->max_unmap_lba_cnt, ISCSI_SCSI_EMU_MAX_UNMAP_LBA_COUNT ); - iscsi_put_be32( (uint8_t *) &vpd_page_block_limits_inquiry_data_pkt->max_unmap_block_desc_cnt, ISCSI_SCSI_EMU_MAX_UNMAP_BLOCK_DESC_COUNT ); - } else { - vpd_page_block_limits_inquiry_data_pkt->max_unmap_lba_cnt = 0UL; - vpd_page_block_limits_inquiry_data_pkt->max_unmap_block_desc_cnt = 0UL; - } + vpd_page_block_limits_inquiry_data_pkt->max_unmap_lba_cnt = 0UL; + vpd_page_block_limits_inquiry_data_pkt->max_unmap_block_desc_cnt = 0UL; vpd_page_block_limits_inquiry_data_pkt->optimal_unmap_granularity = 0UL; vpd_page_block_limits_inquiry_data_pkt->unmap_granularity_align_ugavalid = 0UL; @@ -6628,7 +1614,7 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task alloc_len = sizeof(struct iscsi_scsi_vpd_page_block_dev_chars_inquiry_data_packet); - vpd_page_block_dev_chars_inquiry_data_pkt->medium_rotation_rate = (iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_NO_ROTATION ) ? ISCSI_SCSI_VPD_PAGE_BLOCK_DEV_CHARS_INQUIRY_DATA_MEDIUM_ROTATION_RATE_NONE : ISCSI_SCSI_VPD_PAGE_BLOCK_DEV_CHARS_INQUIRY_DATA_MEDIUM_ROTATION_RATE_NOT_REPORTED); + vpd_page_block_dev_chars_inquiry_data_pkt->medium_rotation_rate = ISCSI_SCSI_VPD_PAGE_BLOCK_DEV_CHARS_INQUIRY_DATA_MEDIUM_ROTATION_RATE_NONE; vpd_page_block_dev_chars_inquiry_data_pkt->product_type = ISCSI_SCSI_VPD_PAGE_BLOCK_DEV_CHARS_INQUIRY_DATA_PRODUCT_TYPE_NOT_INDICATED; vpd_page_block_dev_chars_inquiry_data_pkt->flags = ISCSI_SCSI_VPD_PAGE_BLOCK_DEV_CHARS_INQUIRY_DATA_FLAGS_PUT_NOMINAL_FORM_FACTOR(ISCSI_SCSI_VPD_PAGE_BLOCK_DEV_CHARS_INQUIRY_DATA_FLAGS_NOMINAL_FORM_FACTOR_NOT_REPORTED); vpd_page_block_dev_chars_inquiry_data_pkt->support_flags = 0U; @@ -6646,28 +1632,6 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task break; } - case ISCSI_SCSI_VPD_PAGE_INQUIRY_DATA_PAGE_CODE_THIN_PROVISION : { - if ( !iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_UNMAP ) ) { - scsi_task->xfer_pos = 0UL; - - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return -1; - } - - iscsi_scsi_vpd_page_thin_provision_inquiry_data_packet *vpd_page_thin_provision_inquiry_data_pkt = (iscsi_scsi_vpd_page_thin_provision_inquiry_data_packet *) vpd_page_inquiry_data_pkt->params; - - alloc_len = sizeof(struct iscsi_scsi_vpd_page_thin_provision_inquiry_data_packet); - - vpd_page_thin_provision_inquiry_data_pkt->threshold_exponent = 0U; - vpd_page_thin_provision_inquiry_data_pkt->flags = (int8_t) ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_FLAGS_LBPU; - vpd_page_thin_provision_inquiry_data_pkt->provision_type = ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PUT_PROVISION_TYPE(ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_THIN_PROVISIONING); - vpd_page_thin_provision_inquiry_data_pkt->reserved = 0U; - - iscsi_put_be16( (uint8_t *) &vpd_page_inquiry_data_pkt->alloc_len, (uint16_t) alloc_len ); - - break; - } default : { scsi_task->xfer_pos = 0UL; @@ -6680,138 +1644,85 @@ static int iscsi_scsi_emu_primary_inquiry(dnbd3_image_t *image, iscsi_scsi_task } return (int) (alloc_len + sizeof(struct iscsi_scsi_vpd_page_inquiry_data_packet)); - } else { - int32_t scsi_device_type = iscsi_config_get( (uint8_t *) image->name, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_DEVICE_TYPE ); - uint alloc_len; - - if ( scsi_device_type < 0L ) - scsi_device_type = iscsi_config_get( NULL, ISCSI_GLOBALS_CONFIG_TYPE_SCSI_DEVICE_TYPE ); - - const uint8_t pti = ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_PERIPHERAL_TYPE(scsi_device_type) | ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_PERIPHERAL_ID(ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_ID_POSSIBLE); - - std_inquiry_data_pkt->basic_inquiry.peripheral_type_id = pti; - std_inquiry_data_pkt->basic_inquiry.peripheral_type_mod_flags = (int8_t) (iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_REMOVABLE ) ? ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_MOD_FLAGS_REMOVABLE_MEDIA : 0); - std_inquiry_data_pkt->basic_inquiry.version = ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_VERSION_ANSI(ISCSI_SCSI_BASIC_INQUIRY_DATA_VERSION_ANSI_SPC3); - std_inquiry_data_pkt->basic_inquiry.response_data_fmt_flags = ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_RESPONSE_DATA_FMT_FLAGS(ISCSI_SCSI_BASIC_INQUIRY_DATA_RESPONSE_DATA_FMT_FLAGS_SCSI_2) | ISCSI_SCSI_BASIC_INQUIRY_DATA_RESPONSE_DATA_FMT_FLAGS_HISUP; - - std_inquiry_data_pkt->tpgs_flags = 0U; - std_inquiry_data_pkt->services_flags = ISCSI_SCSI_STD_INQUIRY_DATA_SERVICES_FLAGS_MULTIP; - std_inquiry_data_pkt->flags = ISCSI_SCSI_STD_INQUIRY_DATA_FLAGS_COMMAND_QUEUE; - - iscsi_strcpy_pad( (char *) std_inquiry_data_pkt->vendor_id, ISCSI_SCSI_STD_INQUIRY_DATA_DISK_VENDOR_ID, sizeof(std_inquiry_data_pkt->vendor_id), ' ' ); - iscsi_strcpy_pad( (char *) std_inquiry_data_pkt->product_id, image->name, sizeof(std_inquiry_data_pkt->product_id), ' ' ); - - char image_rev[sizeof(std_inquiry_data_pkt->product_rev_level) + 1]; - - sprintf( image_rev, "%04" PRIX16, image->rid ); - iscsi_strcpy_pad( (char *) std_inquiry_data_pkt->product_rev_level, image_rev, sizeof(std_inquiry_data_pkt->product_rev_level), ' ' ); - - uint add_len = (sizeof(struct iscsi_scsi_std_inquiry_data_packet) - sizeof(struct iscsi_scsi_basic_inquiry_data_packet)); - iscsi_scsi_ext_inquiry_data_packet *ext_inquiry_data_pkt = (iscsi_scsi_ext_inquiry_data_packet *) std_inquiry_data_pkt; + } - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, vendor_spec) ) { - iscsi_strcpy_pad( (char *) ext_inquiry_data_pkt->vendor_spec, ISCSI_SCSI_EXT_INQUIRY_DATA_VENDOR_SPEC_ID, sizeof(ext_inquiry_data_pkt->vendor_spec), ' ' ); + const uint8_t pti = ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_PERIPHERAL_TYPE(ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_TYPE_DIRECT) | ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_PERIPHERAL_ID(ISCSI_SCSI_BASIC_INQUIRY_DATA_PERIPHERAL_ID_POSSIBLE); - add_len += sizeof(ext_inquiry_data_pkt->vendor_spec); - } + std_inquiry_data_pkt->basic_inquiry.peripheral_type_id = pti; + std_inquiry_data_pkt->basic_inquiry.peripheral_type_mod_flags = 0; + std_inquiry_data_pkt->basic_inquiry.version = ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_VERSION_ANSI(ISCSI_SCSI_BASIC_INQUIRY_DATA_VERSION_ANSI_SPC3); + std_inquiry_data_pkt->basic_inquiry.response_data_fmt_flags = ISCSI_SCSI_BASIC_INQUIRY_DATA_PUT_RESPONSE_DATA_FMT_FLAGS(ISCSI_SCSI_BASIC_INQUIRY_DATA_RESPONSE_DATA_FMT_FLAGS_SCSI_2) | ISCSI_SCSI_BASIC_INQUIRY_DATA_RESPONSE_DATA_FMT_FLAGS_HISUP; - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, flags) ) { - ext_inquiry_data_pkt->flags = 0; + std_inquiry_data_pkt->tpgs_flags = 0U; + std_inquiry_data_pkt->services_flags = ISCSI_SCSI_STD_INQUIRY_DATA_SERVICES_FLAGS_MULTIP; + std_inquiry_data_pkt->flags = ISCSI_SCSI_STD_INQUIRY_DATA_FLAGS_COMMAND_QUEUE; - add_len += sizeof(ext_inquiry_data_pkt->flags); - } + iscsi_strcpy_pad( (char *) std_inquiry_data_pkt->vendor_id, ISCSI_SCSI_STD_INQUIRY_DATA_DISK_VENDOR_ID, sizeof(std_inquiry_data_pkt->vendor_id), ' ' ); + iscsi_strcpy_pad( (char *) std_inquiry_data_pkt->product_id, image->name, sizeof(std_inquiry_data_pkt->product_id), ' ' ); - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, reserved) ) { - ext_inquiry_data_pkt->reserved = 0U; + char image_rev[sizeof(std_inquiry_data_pkt->product_rev_level) + 1]; - add_len += sizeof(ext_inquiry_data_pkt->reserved); - } + sprintf( image_rev, "%04" PRIX16, image->rid ); + iscsi_strcpy_pad( (char *) std_inquiry_data_pkt->product_rev_level, image_rev, sizeof(std_inquiry_data_pkt->product_rev_level), ' ' ); - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[0]) ) { - iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[0], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_ISCSI_NO_VERSION ); + uint add_len = (sizeof(struct iscsi_scsi_std_inquiry_data_packet) - sizeof(struct iscsi_scsi_basic_inquiry_data_packet)); + iscsi_scsi_ext_inquiry_data_packet *ext_inquiry_data_pkt = (iscsi_scsi_ext_inquiry_data_packet *) std_inquiry_data_pkt; - add_len += sizeof(ext_inquiry_data_pkt->version_desc[0]); - } + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, vendor_spec) ) { + iscsi_strcpy_pad( (char *) ext_inquiry_data_pkt->vendor_spec, ISCSI_SCSI_EXT_INQUIRY_DATA_VENDOR_SPEC_ID, sizeof(ext_inquiry_data_pkt->vendor_spec), ' ' ); - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[1]) ) { - iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[1], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_SPC3_NO_VERSION ); + add_len += sizeof(ext_inquiry_data_pkt->vendor_spec); + } - add_len += sizeof(ext_inquiry_data_pkt->version_desc[1]); - } + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, flags) ) { + ext_inquiry_data_pkt->flags = 0; - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[2]) ) { - iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[2], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_SBC2_NO_VERSION ); + add_len += sizeof(ext_inquiry_data_pkt->flags); + } - add_len += sizeof(ext_inquiry_data_pkt->version_desc[2]); - } + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, reserved) ) { + ext_inquiry_data_pkt->reserved = 0U; - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[3]) ) { - iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[3], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_SAM2_NO_VERSION ); + add_len += sizeof(ext_inquiry_data_pkt->reserved); + } - add_len += sizeof(ext_inquiry_data_pkt->version_desc[3]); - } + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[0]) ) { + iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[0], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_ISCSI_NO_VERSION ); - if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[4]) ) { - uint alloc_len = (uint) (len - offsetof(iscsi_scsi_ext_inquiry_data_packet, version_desc[4])); + add_len += sizeof(ext_inquiry_data_pkt->version_desc[0]); + } - if ( alloc_len > (sizeof(struct iscsi_scsi_ext_inquiry_data_packet) - offsetof(iscsi_scsi_ext_inquiry_data_packet, version_desc[4])) ) - alloc_len = (sizeof(struct iscsi_scsi_ext_inquiry_data_packet) - offsetof(iscsi_scsi_ext_inquiry_data_packet, version_desc[4])); + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[1]) ) { + iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[1], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_SPC3_NO_VERSION ); - memset( &ext_inquiry_data_pkt->version_desc[4], 0, alloc_len ); - add_len += alloc_len; - } + add_len += sizeof(ext_inquiry_data_pkt->version_desc[1]); + } - std_inquiry_data_pkt->basic_inquiry.add_len = (uint8_t) add_len; + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[2]) ) { + iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[2], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_SBC2_NO_VERSION ); - return (int) (add_len + sizeof(struct iscsi_scsi_basic_inquiry_data_packet)); + add_len += sizeof(ext_inquiry_data_pkt->version_desc[2]); } -} -/** - * @brief Fills in a single LUN entry of a report LUNs operation on a DNBD3 image. - * - * Callback function for each element while iterating - * through the iSCSI SCSI LUNs hash map.\n - * The iteration process is aborted when the - * remaining allocation length is not enough - * to hold the current LUN. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL creates an - * empty key assignment. - * @param[in,out] user_data Pointer to a data structure - * containing the report LUN list, the - * current report LUN entry, the total - * length of all LUN entries in bytes, the - * remaining allocation length in bytes and - * the selected report. May NOT be NULL, so - * be careful. - * @retval -1 Operation failure, ran out of - * allocation space during traversal. - * @retval 0 Successful operation, there is enough - * allocation space to store this - * reported LUN entry. - */ -int iscsi_scsi_emu_primary_report_luns_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_scsi_emu_primary_report_luns_fill *lun_report_fill = (iscsi_scsi_emu_primary_report_luns_fill *) user_data; - iscsi_scsi_lun *scsi_lun = (iscsi_scsi_lun *) value; + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[3]) ) { + iscsi_put_be16( (uint8_t *) &ext_inquiry_data_pkt->version_desc[3], ISCSI_SCSI_EXT_INQUIRY_DATA_VERSION_DESC_SAM2_NO_VERSION ); - lun_report_fill->alloc_len -= (uint) sizeof(struct iscsi_scsi_report_luns_parameter_data_lun_entry_packet); + add_len += sizeof(ext_inquiry_data_pkt->version_desc[3]); + } - if ( (int) lun_report_fill->alloc_len < 0 ) - return -1; + if ( len >= ISCSI_NEXT_OFFSET(iscsi_scsi_ext_inquiry_data_packet, version_desc[4]) ) { + uint alloc_len = (uint) (len - offsetof(iscsi_scsi_ext_inquiry_data_packet, version_desc[4])); - lun_report_fill->len += (uint) sizeof(struct iscsi_scsi_report_luns_parameter_data_lun_entry_packet); + if ( alloc_len > (sizeof(struct iscsi_scsi_ext_inquiry_data_packet) - offsetof(iscsi_scsi_ext_inquiry_data_packet, version_desc[4])) ) + alloc_len = (sizeof(struct iscsi_scsi_ext_inquiry_data_packet) - offsetof(iscsi_scsi_ext_inquiry_data_packet, version_desc[4])); - const uint64_t lun = iscsi_scsi_lun_get_from_scsi( scsi_lun->id ); - iscsi_put_be64( (uint8_t *) &lun_report_fill->lun_entry->lun, lun ); + memset( &ext_inquiry_data_pkt->version_desc[4], 0, alloc_len ); + add_len += alloc_len; + } - lun_report_fill->lun_entry++; + std_inquiry_data_pkt->basic_inquiry.add_len = (uint8_t) add_len; - return 0; + return (int) (add_len + sizeof(struct iscsi_scsi_basic_inquiry_data_packet)); } /** @@ -6820,9 +1731,6 @@ int iscsi_scsi_emu_primary_report_luns_callback(uint8_t *key, const size_t key_s * This function also sets the SCSI * status result code accordingly. * - * @param[in] lun Pointer to iSCSI SCSI LUN to - * report the LUNs for. May NOT be - * NULL, so be careful. * @param[in] report_luns_parameter_data_pkt Pointer to report LUNS * parameter data packet to fill the * LUN data data with. @@ -6833,45 +1741,29 @@ int iscsi_scsi_emu_primary_report_luns_callback(uint8_t *key, const size_t key_s * operation, a negative error code * otherwise. */ -static int iscsi_scsi_emu_primary_report_luns(iscsi_scsi_lun *lun, iscsi_scsi_report_luns_parameter_data_lun_list_packet *report_luns_parameter_data_pkt, const uint len, const uint select_report) +static int iscsi_scsi_emu_primary_report_luns( iscsi_scsi_report_luns_parameter_data_lun_list_packet *report_luns_parameter_data_pkt, const uint len, const uint select_report) { - if ( len < sizeof(struct iscsi_scsi_report_luns_parameter_data_lun_list_packet) ) + const uint64_t lun = iscsi_scsi_lun_get_from_scsi( ISCSI_DEFAULT_LUN ); + + if ( len < sizeof(struct iscsi_scsi_report_luns_parameter_data_lun_list_packet) + sizeof(lun) ) return -1; switch ( select_report ) { - case ISCSI_SCSI_CDB_REPORT_LUNS_SELECT_REPORT_LU_ADDR_METHOD : { - break; - } - case ISCSI_SCSI_CDB_REPORT_LUNS_SELECT_REPORT_LU_KNOWN : { - break; - } + case ISCSI_SCSI_CDB_REPORT_LUNS_SELECT_REPORT_LU_ADDR_METHOD : + case ISCSI_SCSI_CDB_REPORT_LUNS_SELECT_REPORT_LU_KNOWN : case ISCSI_SCSI_CDB_REPORT_LUNS_SELECT_REPORT_LU_ALL : { break; } default : { return -1; - - break; } } - report_luns_parameter_data_pkt->lun_list_len = 0UL; report_luns_parameter_data_pkt->reserved = 0UL; + iscsi_put_be32( (uint8_t *) &report_luns_parameter_data_pkt->lun_list_len, sizeof(lun) ); + iscsi_put_be64( (uint8_t *) (report_luns_parameter_data_pkt + 1), lun ); - iscsi_scsi_emu_primary_report_luns_fill lun_report_fill = {report_luns_parameter_data_pkt, (iscsi_scsi_report_luns_parameter_data_lun_entry_packet *) (report_luns_parameter_data_pkt + 1), 0U, (uint) (len - sizeof(struct iscsi_scsi_report_luns_parameter_data_lun_list_packet)), select_report }; - - pthread_rwlock_rdlock( &lun->device->luns_rwlock ); - - const int rc = iscsi_hashmap_iterate( lun->device->luns, iscsi_scsi_emu_primary_report_luns_callback, (uint8_t *) &lun_report_fill ); - - pthread_rwlock_unlock( &lun->device->luns_rwlock ); - - if ( rc < 0 ) - return -1; - - iscsi_put_be32( (uint8_t *) &report_luns_parameter_data_pkt->lun_list_len, lun_report_fill.len ); - - return (int) (lun_report_fill.len + sizeof(struct iscsi_scsi_report_luns_parameter_data_lun_list_packet)); + return (int) (sizeof(lun) + sizeof(struct iscsi_scsi_report_luns_parameter_data_lun_list_packet)); } /** @@ -7059,9 +1951,6 @@ static int iscsi_scsi_emu_primary_mode_sense_page(dnbd3_image_t *image, iscsi_sc iscsi_scsi_emu_primary_mode_sense_page_init( mode_sense_mode_page_pkt, page_len, page, sub_page ); - if ( (mode_sense_mode_page_pkt != NULL) && iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_WRITE_CACHE ) && (pc != ISCSI_SCSI_CDB_MODE_SENSE_6_PAGE_CONTROL_CHG_VALUES) ) - mode_sense_caching_mode_page_pkt->flags |= ISCSI_SCSI_MODE_SENSE_CACHING_MODE_PAGE_FLAGS_WCE; - if ( (mode_sense_mode_page_pkt != NULL) && (pc != ISCSI_SCSI_CDB_MODE_SENSE_6_PAGE_CONTROL_CHG_VALUES) ) mode_sense_caching_mode_page_pkt->flags |= ISCSI_SCSI_MODE_SENSE_CACHING_MODE_PAGE_FLAGS_RCD; @@ -7222,21 +2111,24 @@ static int iscsi_scsi_emu_primary_mode_sense(dnbd3_image_t *image, iscsi_scsi_ta if ( hdr_len == sizeof(struct iscsi_scsi_mode_sense_6_parameter_header_data_packet) ) { mode_sense_6_parameter_hdr_data_pkt->mode_data_len = (uint8_t) (alloc_len - sizeof(uint8_t)); mode_sense_6_parameter_hdr_data_pkt->medium_type = 0U; - mode_sense_6_parameter_hdr_data_pkt->flags = (int8_t) ((iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_PHYSICAL_READ_ONLY ) || iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_WRITE_PROTECT )) ? ISCSI_SCSI_MODE_SENSE_6_PARAM_HDR_DATA_FLAGS_WP : 0); + mode_sense_6_parameter_hdr_data_pkt->flags = ISCSI_SCSI_MODE_SENSE_6_PARAM_HDR_DATA_FLAGS_WP; mode_sense_6_parameter_hdr_data_pkt->block_desc_len = (uint8_t) block_desc_len; - } else { + } else if ( hdr_len == sizeof(struct iscsi_scsi_mode_sense_10_parameter_header_data_packet) ) { iscsi_scsi_mode_sense_10_parameter_header_data_packet *mode_sense_10_parameter_hdr_data_pkt = (iscsi_scsi_mode_sense_10_parameter_header_data_packet *) mode_sense_6_parameter_hdr_data_pkt; iscsi_put_be16( (uint8_t *) &mode_sense_10_parameter_hdr_data_pkt->mode_data_len, (uint16_t) (alloc_len - sizeof(uint16_t)) ); mode_sense_10_parameter_hdr_data_pkt->medium_type = 0U; - mode_sense_10_parameter_hdr_data_pkt->flags = (int8_t) ((iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_PHYSICAL_READ_ONLY ) || iscsi_scsi_emu_io_type_is_supported( image, ISCSI_SCSI_EMU_IO_TYPE_WRITE_PROTECT )) ? ISCSI_SCSI_MODE_SENSE_10_PARAM_HDR_DATA_FLAGS_WP : 0); + mode_sense_10_parameter_hdr_data_pkt->flags = ISCSI_SCSI_MODE_SENSE_10_PARAM_HDR_DATA_FLAGS_WP; mode_sense_10_parameter_hdr_data_pkt->long_lba = (uint8_t) long_lba; mode_sense_10_parameter_hdr_data_pkt->reserved = 0U; iscsi_put_be16( (uint8_t *) &mode_sense_10_parameter_hdr_data_pkt->block_desc_len, (uint16_t) block_desc_len ); + } else { + logadd( LOG_DEBUG1, "iscsi_scsi_emu_primary_mode_sense: invalid parameter header length %u", hdr_len ); + return -1; } const uint64_t num_blocks = iscsi_scsi_emu_block_get_count( image ); - const uint32_t block_size = iscsi_scsi_emu_block_get_size( image ); + const uint32_t block_size = ISCSI_SCSI_EMU_BLOCK_SIZE; if ( block_desc_len == sizeof(struct iscsi_scsi_mode_sense_lba_parameter_block_desc_data_packet) ) { iscsi_scsi_mode_sense_lba_parameter_block_desc_data_packet *lba_parameter_block_desc = (iscsi_scsi_mode_sense_lba_parameter_block_desc_data_packet *) (((uint8_t *) mode_sense_6_parameter_hdr_data_pkt) + hdr_len); @@ -7275,7 +2167,6 @@ static int iscsi_scsi_emu_primary_mode_sense(dnbd3_image_t *image, iscsi_scsi_ta */ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) { - iscsi_scsi_lun *lun = scsi_task->lun; uint alloc_len; uint len; int rc; @@ -7284,9 +2175,6 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) case ISCSI_SCSI_OPCODE_INQUIRY : { const iscsi_scsi_cdb_inquiry *cdb_inquiry = (iscsi_scsi_cdb_inquiry *) scsi_task->cdb; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - alloc_len = iscsi_get_be16(cdb_inquiry->alloc_len); len = alloc_len; @@ -7305,7 +2193,7 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) } } - rc = iscsi_scsi_emu_primary_inquiry( lun->image, scsi_task, cdb_inquiry, std_inquiry_data_pkt, len ); + rc = iscsi_scsi_emu_primary_inquiry( scsi_task->connection->client->image, scsi_task, cdb_inquiry, std_inquiry_data_pkt, len ); if ( (rc >= 0) && (len > 0U) ) { if ( len > alloc_len ) @@ -7352,7 +2240,7 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) } } - rc = iscsi_scsi_emu_primary_report_luns( lun, report_luns_parameter_data_pkt, len, cdb_report_luns->select_report ); + rc = iscsi_scsi_emu_primary_report_luns( report_luns_parameter_data_pkt, len, cdb_report_luns->select_report ); if ( rc < 0 ) { free( report_luns_parameter_data_pkt ); @@ -7375,76 +2263,17 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) break; } - case ISCSI_SCSI_OPCODE_MODESELECT6 : { - const iscsi_scsi_cdb_mode_select_6 *cdb_mode_select_6 = (iscsi_scsi_cdb_mode_select_6 *) scsi_task->cdb; - - alloc_len = cdb_mode_select_6->param_list_len; - - if ( alloc_len == 0U ) - break; - - rc = iscsi_scsi_emu_check_len( scsi_task, alloc_len, sizeof(struct iscsi_scsi_mode_select_6_parameter_list_packet) ); - - if ( rc < 0 ) - break; - - len = scsi_task->len; - - if ( alloc_len < sizeof(struct iscsi_scsi_mode_select_6_parameter_list_packet) ) - alloc_len = sizeof(struct iscsi_scsi_mode_select_6_parameter_list_packet); - - rc = iscsi_scsi_emu_check_len( scsi_task, len, alloc_len ); - - if ( rc < 0 ) - break; - - scsi_task->xfer_pos = alloc_len; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - - break; - } - case ISCSI_SCSI_OPCODE_MODESELECT10 : { - const iscsi_scsi_cdb_mode_select_10 *cdb_mode_select_10 = (iscsi_scsi_cdb_mode_select_10 *) scsi_task->cdb; - - alloc_len = iscsi_get_be16(cdb_mode_select_10->param_list_len); - - if ( alloc_len == 0U ) - break; - - rc = iscsi_scsi_emu_check_len( scsi_task, alloc_len, sizeof(struct iscsi_scsi_mode_select_10_parameter_list_packet) ); - - if ( rc < 0 ) - break; - - len = scsi_task->len; - - if ( alloc_len < sizeof(struct iscsi_scsi_mode_select_10_parameter_list_packet) ) - alloc_len = sizeof(struct iscsi_scsi_mode_select_10_parameter_list_packet); - - rc = iscsi_scsi_emu_check_len( scsi_task, len, alloc_len ); - - if ( rc < 0 ) - break; - - scsi_task->xfer_pos = alloc_len; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - - break; - } case ISCSI_SCSI_OPCODE_MODESENSE6 : { const iscsi_scsi_cdb_mode_sense_6 *cdb_mode_sense_6 = (iscsi_scsi_cdb_mode_sense_6 *) scsi_task->cdb; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - alloc_len = cdb_mode_sense_6->alloc_len; - const uint block_desc_len = (((cdb_mode_sense_6->flags & ISCSI_SCSI_CDB_MODE_SENSE_6_FLAGS_DBD) == 0) ? sizeof(struct iscsi_scsi_mode_sense_lba_parameter_block_desc_data_packet) : 0U); + const uint block_desc_len = ((cdb_mode_sense_6->flags & ISCSI_SCSI_CDB_MODE_SENSE_6_FLAGS_DBD) == 0) ? sizeof(struct iscsi_scsi_mode_sense_lba_parameter_block_desc_data_packet) : 0U; const uint pc = ISCSI_SCSI_CDB_MODE_SENSE_6_GET_PAGE_CONTROL(cdb_mode_sense_6->page_code_control); const uint page = ISCSI_SCSI_CDB_MODE_SENSE_6_GET_PAGE_CODE(cdb_mode_sense_6->page_code_control); const uint sub_page = cdb_mode_sense_6->sub_page_code; - rc = iscsi_scsi_emu_primary_mode_sense( lun->image, scsi_task, NULL, sizeof(struct iscsi_scsi_mode_sense_6_parameter_header_data_packet), block_desc_len, 0U, pc, page, sub_page ); + rc = iscsi_scsi_emu_primary_mode_sense( scsi_task->connection->client->image, scsi_task, NULL, sizeof(struct iscsi_scsi_mode_sense_6_parameter_header_data_packet), block_desc_len, 0U, pc, page, sub_page ); if ( rc < 0 ) break; @@ -7459,7 +2288,7 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) break; } - rc = iscsi_scsi_emu_primary_mode_sense( lun->image, scsi_task, mode_sense_6_parameter_hdr_data_pkt, sizeof(struct iscsi_scsi_mode_sense_6_parameter_header_data_packet), block_desc_len, 0U, pc, page, sub_page ); + rc = iscsi_scsi_emu_primary_mode_sense( scsi_task->connection->client->image, scsi_task, mode_sense_6_parameter_hdr_data_pkt, sizeof(struct iscsi_scsi_mode_sense_6_parameter_header_data_packet), block_desc_len, 0U, pc, page, sub_page ); if ( rc < 0 ) { free( mode_sense_6_parameter_hdr_data_pkt ); @@ -7486,9 +2315,6 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) case ISCSI_SCSI_OPCODE_MODESENSE10 : { const iscsi_scsi_cdb_mode_sense_10 *cdb_mode_sense_10 = (iscsi_scsi_cdb_mode_sense_10 *) scsi_task->cdb; - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - alloc_len = iscsi_get_be16(cdb_mode_sense_10->alloc_len); const uint long_lba = (((cdb_mode_sense_10->flags & ISCSI_SCSI_CDB_MODE_SENSE_10_FLAGS_LLBAA) != 0) ? ISCSI_SCSI_MODE_SENSE_10_PARAM_HDR_DATA_LONGLBA : 0U); @@ -7497,7 +2323,7 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) const uint page10 = ISCSI_SCSI_CDB_MODE_SENSE_10_GET_PAGE_CODE(cdb_mode_sense_10->page_code_control); const uint sub_page10 = cdb_mode_sense_10->sub_page_code; - rc = iscsi_scsi_emu_primary_mode_sense( lun->image, scsi_task, NULL, sizeof(struct iscsi_scsi_mode_sense_10_parameter_header_data_packet), block_desc_len, long_lba, pc10, page10, sub_page10 ); + rc = iscsi_scsi_emu_primary_mode_sense( scsi_task->connection->client->image, scsi_task, NULL, sizeof(struct iscsi_scsi_mode_sense_10_parameter_header_data_packet), block_desc_len, long_lba, pc10, page10, sub_page10 ); if ( rc < 0 ) break; @@ -7512,7 +2338,7 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) break; } - rc = iscsi_scsi_emu_primary_mode_sense( lun->image, scsi_task, (iscsi_scsi_mode_sense_6_parameter_header_data_packet *) mode_sense_10_parameter_hdr_data_pkt, sizeof(struct iscsi_scsi_mode_sense_10_parameter_header_data_packet), block_desc_len, long_lba, pc10, page10, sub_page10 ); + rc = iscsi_scsi_emu_primary_mode_sense( scsi_task->connection->client->image, scsi_task, (iscsi_scsi_mode_sense_6_parameter_header_data_packet *) mode_sense_10_parameter_hdr_data_pkt, sizeof(struct iscsi_scsi_mode_sense_10_parameter_header_data_packet), block_desc_len, long_lba, pc10, page10, sub_page10 ); if ( rc < 0 ) { free( mode_sense_10_parameter_hdr_data_pkt ); @@ -7536,176 +2362,18 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) break; } - case ISCSI_SCSI_OPCODE_REQUESTSENSE : { - const iscsi_scsi_cdb_req_sense *cdb_req_sense = (iscsi_scsi_cdb_req_sense *) scsi_task->cdb; - - if ( (cdb_req_sense->flags & ISCSI_SCSI_CDB_REQ_SENSE_FLAGS_DESC) != 0 ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_FIELD_IN_CDB, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - break; - } - - alloc_len = cdb_req_sense->alloc_len; - - iscsi_scsi_task_sense_data_build( scsi_task, ISCSI_SCSI_SENSE_KEY_NO_SENSE, ISCSI_SCSI_ASC_NO_ADDITIONAL_SENSE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - len = scsi_task->sense_data_len; - - if ( len > 0U ) { - iscsi_scsi_sense_data_check_cond_packet *sense_data = (iscsi_scsi_sense_data_check_cond_packet *) malloc( len ); - - if ( sense_data == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NOT_READY, ISCSI_SCSI_ASC_LOGICAL_UNIT_NOT_READY, ISCSI_SCSI_ASCQ_BECOMING_READY ); - - break; - } - - memcpy( sense_data, scsi_task->sense_data, len ); - - if ( len > alloc_len ) - len = alloc_len; - - scsi_task->buf = (uint8_t *) sense_data; - } - - scsi_task->xfer_pos = len; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - - break; - } - case ISCSI_SCSI_OPCODE_LOGSELECT : - case ISCSI_SCSI_OPCODE_LOGSENSE : { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_COMMAND_OPERATION_CODE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - break; - } case ISCSI_SCSI_OPCODE_TESTUNITREADY : { - if ( !iscsi_scsi_emu_image_init( scsi_task, false ) ) - break; - scsi_task->xfer_pos = 0UL; scsi_task->status = ISCSI_SCSI_STATUS_GOOD; break; } case ISCSI_SCSI_OPCODE_STARTSTOPUNIT : { - // TODO: Handle eject image and power saving (suspend and standby) modes. - - if ( !iscsi_scsi_emu_image_init( scsi_task, true ) ) - break; - scsi_task->xfer_pos = 0UL; scsi_task->status = ISCSI_SCSI_STATUS_GOOD; break; } - case ISCSI_SCSI_OPCODE_PERSISTENT_RESERVE_OUT : { - const iscsi_scsi_cdb_pr_reserve_out *cdb_pr_reserve_out = (iscsi_scsi_cdb_pr_reserve_out *) scsi_task->cdb; - - alloc_len = iscsi_get_be32(cdb_pr_reserve_out->param_list_len); - rc = iscsi_scsi_emu_check_len( scsi_task, alloc_len, sizeof(struct iscsi_scsi_pr_reserve_out_parameter_list_packet) ); - - if ( rc < 0 ) - break; - - len = scsi_task->len; - - iscsi_scsi_pr_reserve_out_parameter_list_packet *pr_reserve_out_parameter_list = (iscsi_scsi_pr_reserve_out_parameter_list_packet *) malloc( len ); - - if ( pr_reserve_out_parameter_list == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NOT_READY, ISCSI_SCSI_ASC_LOGICAL_UNIT_NOT_READY, ISCSI_SCSI_ASCQ_BECOMING_READY ); - - break; - } - - if ( len < sizeof(struct iscsi_scsi_pr_reserve_out_parameter_list_packet) ) { - free( pr_reserve_out_parameter_list ); - - break; - } - - rc = iscsi_scsi_pr_out( scsi_task, pr_reserve_out_parameter_list, cdb_pr_reserve_out, len ); - - if ( rc < 0 ) { - free( pr_reserve_out_parameter_list ); - - break; - } - - scsi_task->xfer_pos = alloc_len; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - - free( pr_reserve_out_parameter_list ); - - break; - } - case ISCSI_SCSI_OPCODE_PERSISTENT_RESERVE_IN : { - const iscsi_scsi_cdb_pr_reserve_in *cdb_pr_reserve_in = (iscsi_scsi_cdb_pr_reserve_in *) scsi_task->cdb; - - alloc_len = iscsi_get_be16(cdb_pr_reserve_in->param_list_len); - len = alloc_len; - - iscsi_scsi_pr_reserve_in_parameter_data_packet *pr_reserve_in_parameter_data = (iscsi_scsi_pr_reserve_in_parameter_data_packet *) malloc( len ); - - if ( pr_reserve_in_parameter_data == NULL ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_NOT_READY, ISCSI_SCSI_ASC_LOGICAL_UNIT_NOT_READY, ISCSI_SCSI_ASCQ_BECOMING_READY ); - - break; - } - - rc = iscsi_scsi_pr_in( scsi_task, pr_reserve_in_parameter_data, cdb_pr_reserve_in, len ); - - if ( (rc >= 0) && (len > 0U) ) { - if ( len > alloc_len ) - len = alloc_len; - - scsi_task->buf = (uint8_t *) pr_reserve_in_parameter_data; - rc = len; - } - - if ( rc >= 0 ) { - scsi_task->xfer_pos = rc; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - } - - break; - } - case ISCSI_SCSI_OPCODE_RESERVE6 : { - const iscsi_scsi_cdb_pr_reserve_6 *cdb_pr_reserve_6 = (iscsi_scsi_cdb_pr_reserve_6 *) scsi_task->cdb; - - rc = iscsi_scsi_pr_reserve_scsi2( scsi_task, cdb_pr_reserve_6 ); - - if ( rc >= 0 ) { - scsi_task->xfer_pos = rc; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - } - - break; - } - case ISCSI_SCSI_OPCODE_RESERVE10 : { - const iscsi_scsi_cdb_pr_reserve_10 *cdb_pr_reserve_10 = (iscsi_scsi_cdb_pr_reserve_10 *) scsi_task->cdb; - - rc = iscsi_scsi_pr_reserve_scsi2( scsi_task, (iscsi_scsi_cdb_pr_reserve_6 *) cdb_pr_reserve_10 ); - rc = iscsi_get_be16(cdb_pr_reserve_10->param_list_len); - - if ( rc >= 0 ) { - scsi_task->xfer_pos = rc; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - } - - break; - } - case ISCSI_SCSI_OPCODE_RELEASE6 : - case ISCSI_SCSI_OPCODE_RELEASE10 : { - rc = iscsi_scsi_pr_release_scsi2( scsi_task ); - - if ( rc >= 0 ) { - scsi_task->xfer_pos = rc; - scsi_task->status = ISCSI_SCSI_STATUS_GOOD; - } - - break; - } default : { return ISCSI_SCSI_TASK_RUN_UNKNOWN; @@ -7717,957 +2385,6 @@ static int iscsi_scsi_emu_primary_process(iscsi_scsi_task *scsi_task) } /** - * @brief Executes the iSCSI SCSI emulation for an iSCSI SCSI task. - * - * This function also handles all SCSI emulation - * tasks for DNBD3 image mapping. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task for which - * SCSI should be emulated and may NOT be NULL, - * so be careful. - * @return 0 on successful SCSI emulation or a - * negative error code otherwise. - */ -int iscsi_scsi_emu_exec(iscsi_scsi_task *scsi_task) -{ - int rc = iscsi_scsi_emu_block_process( scsi_task ); - - if ( rc == ISCSI_SCSI_TASK_RUN_UNKNOWN ) { - rc = iscsi_scsi_emu_primary_process( scsi_task ); - - if ( rc == ISCSI_SCSI_TASK_RUN_UNKNOWN ) { - iscsi_scsi_task_status_set( scsi_task, ISCSI_SCSI_STATUS_CHECK_COND, ISCSI_SCSI_SENSE_KEY_ILLEGAL_REQ, ISCSI_SCSI_ASC_INVALID_COMMAND_OPERATION_CODE, ISCSI_SCSI_ASCQ_CAUSE_NOT_REPORTABLE ); - - return ISCSI_SCSI_TASK_RUN_COMPLETE; - } - } - - return rc; -} - -/** - * @brief Allocates and initializes an iSCSI port. - * - * THis function marks the port in use, but does - * NOT set a transport ID. Everything else is - * initialized, however. - * - * @param[in] name Pointer to port name. This - * may NOT be NULL, so be careful. - * @param[in] id Identifier for this port. - * @param[in] index Index number for this port. - * @return Pointer to initialized iSCSI port or NULL - * in case of memory exhaustion. - */ -iscsi_port *iscsi_port_create(const uint8_t *name, const uint64_t id, const uint16_t index) -{ - iscsi_port *port = (iscsi_port *) malloc( sizeof(struct iscsi_port) ); - - if ( port == NULL ) { - logadd( LOG_ERROR, "iscsi_port_create: Out of memory allocating iSCSI port" ); - - return NULL; - } - - const uint name_len = (uint) (strlen( (char *) name ) + 1UL); - - port->name = (uint8_t *) malloc( name_len ); - - if ( port->name == NULL ) { - logadd( LOG_ERROR, "iscsi_port_create: Out of memory allocating iSCSI port name" ); - - free( port ); - - return NULL; - } - - memcpy( port->name, name, name_len ); - - port->transport_id = NULL; - port->id = id; - port->index = index; - port->flags = ISCSI_PORT_FLAGS_IN_USE; - port->transport_id_len = 0U; - - return port; -} - -/** - * @brief iSCSI port destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * port stored in the iSCSI device hash map. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_port_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_port_destroy( (iscsi_port *) value ); - - return 0; -} - -/** - * @brief Deallocates all resources acquired iscsi_port_create. - * - * This function also frees the port name and transport ID, - * if they exist. - * - * @param[in] port iSCSI port to deallocate. This may - * be NULL in which case nothing happens. - */ -void iscsi_port_destroy(iscsi_port *port) -{ - if ( port != NULL ) { - if ( port->name != NULL ) { - free( port->name ); - - port->name = NULL; - } - - if ( port->transport_id != NULL ) { - free( port->transport_id ); - - port->transport_id = NULL; - } - - free( port ); - } -} - -/** - * @brief Retrieves the name of an iSCSI port. - * - * This function is just a getter. - * - * @param[in] port Pointer to iSCSI port to retrieve - * the name from and may NOT be NULL, so be - * careful. - * @return Pointer to string containing the name - * of the iSCSI port. - */ -uint8_t *iscsi_port_get_name(const iscsi_port *port) -{ - return port->name; -} - -/** - * @brief Sets the SCSI transport ID of the iSCSI port. - * - * This function constructs the SCSI packet data - * for the SCSI transport id by assigning a name - * and the Initiator Session ID (ISID).\n - * Currently, always transport ID format 0x1 will - * be created. - * - * @param[in] Pointer to iSCSI port to assign the - * SCSI transport ID to. May NOT be NULL, so be - * careful. - * @param[in] Pointer to iSCSI name to assign - * along with the ISID as name. - * @param[in] Initiator Session ID (ISID). - * @return 0 if transport ID could be created - * successfully, a negative error code - * otherwise. - */ -int iscsi_port_transport_id_set(iscsi_port *port, const uint8_t *name, const uint64_t isid) -{ - uint8_t *tmp_buf = iscsi_sprintf_alloc( "%s,i,0x%12.12" PRIx64, name, isid ); - - if ( tmp_buf == NULL ) { - logadd( LOG_ERROR, "iscsi_port_transport_id_set: Out of memory allocating SCSI transport ID name for iSCSI port" ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - const uint name_len = (uint) (strlen( (char *) tmp_buf ) + 1U); - const uint len = ISCSI_ALIGN(name_len, ISCSI_ALIGN_SIZE); - - if ( (len < 20U) || ((len + offsetof(struct iscsi_transport_id, name)) >= 65536U) ) { - logadd( LOG_ERROR, "iscsi_port_transport_id_set: Out of memory allocating SCSI transport ID for iSCSI port" ); - - free( tmp_buf ); - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER; - } - - port->transport_id = (iscsi_transport_id *) malloc( sizeof(struct iscsi_transport_id) + len ); - - if ( port->transport_id == NULL ) { - logadd( LOG_ERROR, "iscsi_port_transport_id_set: Out of memory allocating SCSI transport ID for iSCSI port" ); - - free( tmp_buf ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - port->transport_id->id = (ISCSI_TRANSPORT_ID_PUT_PROTOCOL_ID(ISCSI_TRANSPORT_ID_PROTOCOL_ID_ISCSI) | ISCSI_TRANSPORT_ID_PUT_FORMAT(ISCSI_TRANSPORT_ID_PROTOCOL_ID_ISCSI)); - port->transport_id->reserved = 0U; - iscsi_put_be16( (uint8_t *) &port->transport_id->add_len, (uint16_t) len ); - - memcpy( ((uint8_t *) port->transport_id) + offsetof(struct iscsi_transport_id, name), tmp_buf, name_len ); - memset( ((uint8_t *) port->transport_id) + offsetof(struct iscsi_transport_id, name) + name_len, 0, (len - name_len) ); - - port->transport_id_len = (uint16_t) (offsetof(struct iscsi_transport_id, name) + len); - - free( tmp_buf ); - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Creates and initializes an iSCSI device with a maximum number of LUNs. - * - * This function creates a virtual SCSI device - * which links the DNBD3 images to their LUNs. - * - * @param[in] name Pointer to name of iSCSI device, - * may NOT be NULL, so be careful. - * @param[in] lun_id Initial LUN identifier to create. - * @param[in] protocol_id Protocol identifier. - * @return Pointer to iSCSI device or NULL in - * case of an error. - */ -iscsi_device *iscsi_device_create(const uint8_t *name, const int lun_id, const uint8_t protocol_id) -{ - iscsi_device *device = (iscsi_device *) malloc( sizeof(struct iscsi_device) ); - - if ( device == NULL ) { - logadd( LOG_ERROR, "iscsi_device_create: Out of memory allocating iSCSI device" ); - - return NULL; - } - - const uint len = (uint) (strlen( (char *) name ) + 1U); - - device->name = malloc( len ); - - if ( device->name == NULL ) { - logadd( LOG_ERROR, "iscsi_device_create: Out of memory allocating iSCSI device name" ); - - free( device ); - - return NULL; - } - - memcpy( device->name, name, len ); - - device->luns = iscsi_hashmap_create( 8U ); - - if ( device->luns == NULL ) { - logadd( LOG_ERROR, "iscsi_device_create: Out of memory allocating iSCSI device LUN hash map" ); - - free( device->name ); - free( device ); - - return NULL; - } - - iscsi_scsi_lun *lun = iscsi_scsi_lun_create( lun_id ); - - if ( lun == NULL ) { - logadd( LOG_ERROR, "iscsi_device_create: Out of memory allocating iSCSI device LUN hash map" ); - - iscsi_hashmap_destroy( device->luns ); - free( device->name ); - free( device ); - - return NULL; - } - - if ( pthread_rwlock_init( &device->luns_rwlock, NULL ) != 0 ) { - iscsi_scsi_lun_destroy( lun ); - iscsi_hashmap_destroy( device->luns ); - free( device->name ); - free( device ); - - return NULL; - } - - const uint64_t lun_hash = lun_id; - uint8_t *hash_key = iscsi_hashmap_key_create( (uint8_t *) &lun_hash, sizeof(lun_hash) ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_device_create: Out of memory allocating iSCSI device LUN hash map" ); - - pthread_rwlock_destroy( &device->luns_rwlock ); - iscsi_scsi_lun_destroy( lun ); - iscsi_hashmap_destroy( device->luns ); - free( device->name ); - free( device ); - - return NULL; - } - - const int rc = iscsi_hashmap_put( device->luns, hash_key, sizeof(lun_hash), (uint8_t *) lun ); - - if ( rc < 0 ) { - iscsi_hashmap_key_destroy( hash_key ); - pthread_rwlock_destroy( &device->luns_rwlock ); - iscsi_scsi_lun_destroy( lun ); - iscsi_hashmap_destroy( device->luns ); - free( device->name ); - free( device ); - - return NULL; - } - - lun->device = device; - - device->ports = iscsi_hashmap_create( 0U ); - - if ( device->ports == NULL ) { - logadd( LOG_ERROR, "iscsi_device_create: Out of memory allocating iSCSI device ports hash map" ); - - iscsi_hashmap_key_destroy( hash_key ); - pthread_rwlock_destroy( &device->luns_rwlock ); - iscsi_scsi_lun_destroy( lun ); - iscsi_hashmap_destroy( device->luns ); - free( device->name ); - free( device ); - - return NULL; - } - - device->id = 0; - device->flags = 0; - device->active_conns = 0UL; - device->protocol_id = protocol_id; - - return device; -} - -/** - * @brief iSCSI device destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * device stored in the hash map managing all iSCSI - * devices. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_device_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_device_destroy( (iscsi_device *) value ); - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** - * @brief Deallocates all resources acquired by iscsi_device_create. - * - * This function also frees the associated - * iSCSI ports, LUNs and the device name. - * - * @param[in] device Pointer to iSCSI device to be freed. May - * be NULL in which case this function does - * nothing at all. - */ -void iscsi_device_destroy(iscsi_device *device) -{ - if ( device != NULL ) { - if ( device->ports != NULL ) { - iscsi_hashmap_iterate( device->ports, iscsi_port_destroy_callback, NULL ); - iscsi_hashmap_destroy( device->ports ); - - device->ports = NULL; - } - - pthread_rwlock_destroy( &device->luns_rwlock ); - - if ( device->luns != NULL ) { - iscsi_hashmap_iterate( device->luns, iscsi_scsi_lun_destroy_callback, NULL ); - iscsi_hashmap_destroy( device->luns ); - - device->luns = NULL; - } - - if ( device->name != NULL ) { - free( device->name ); - - device->name = NULL; - } - - free( device ); - } -} - -/** - * @brief Gets an iSCSI device being in use by portal group identifier. - * - * This function uses the unique portal group - * identifier in order to get the port. - * - * @param[in] device Pointer to iSCSI device to be searched. May - * NOT be NULL, so take caution. - * @param[in] id Portal group ID to be searched for. - * @return Pointer to iSCSI port belonging to the iSCSI - * portal group ID or NULL if either the portal - * group ID does not exist or the port is NOT in use. - */ -iscsi_port *iscsi_device_find_port_by_portal_group_tag(const iscsi_device *device, const uint64_t id) -{ - iscsi_port *port; - - if ( iscsi_hashmap_get( device->ports, (uint8_t *) &id, sizeof(id), (uint8_t **) &port ) < 0 ) - return NULL; - - if ( (port == NULL) || ((port->flags & ISCSI_PORT_FLAGS_IN_USE) == 0) ) - return NULL; - - return port; -} - -/** - * @brief Searches an iSCSI LUN by LUN identifier. - * - * This function searches for an iSCSI LUN by - * iterating through the iSCSI device LUN - * hash map. - * - * @param[in] device Pointer to iSCSI device to - * search in the LUN hash map. May NOT be - * NULL, so be careful. - * @param[in] lun_id LUN identifier to be searched - * for. - * @return Pointer to found iSCSI LUN or NULL in - * case no iSCSI LUN has a matching LUN - * identifier. - */ -iscsi_scsi_lun *iscsi_device_find_lun(iscsi_device *device, const int lun_id) -{ - const uint64_t hash_key = (uint64_t) lun_id; - iscsi_scsi_lun *lun; - - const int rc = iscsi_hashmap_get( device->luns, (uint8_t *) &hash_key, sizeof(hash_key), (uint8_t **) &lun ); - - if ( (rc < 0) || ((lun->flags & ISCSI_SCSI_LUN_FLAGS_REMOVED) != 0) ) - return NULL; - - return lun; -} - -/** - * @brief Creates, initializes and adds an iSCSI target port to an iSCSI device. - * - * This function checks whether the iSCSI - * target port already exists for the - * device. - * - * @param[in] device Pointer to iSCSI device to - * add the port for. May NOT be NULL, so - * be careful. - * @param[in] name Pointer to string containing - * the name for the iSCSI target port. - * NULL is NOT allowed here, take caution. - * @param[in] id Unique iSCSI target port - * identifier to be used. - * @return 0 on successful operation, 1 if - * the port already exists or a - * negative error code otherwise. - */ -int iscsi_device_port_add(iscsi_device *device, const uint8_t *name, const uint64_t id) -{ - if ( iscsi_hashmap_contains( device->ports, (uint8_t *) &id, sizeof(id) ) ) - return 1; - - iscsi_port *port = iscsi_port_create( name, id, (uint16_t) iscsi_hashmap_size( device->ports ) ); - - if ( port == NULL ) - return -1; - - const int rc = iscsi_hashmap_put( device->ports, (uint8_t *) &port->id, sizeof(port->id), (uint8_t *) port ); - - if ( rc < 0 ) { - iscsi_port_destroy( port ); - - return -1; - } - - return 0; -} - -/** - * @brief Enqueues an iSCSI SCSI task to the first LUN of an iSCSI device. - * - * This function adds an iSCSI SCSI task - * with an unique task identifier to the - * first LUN of an iSCSI device. - * - * @param[in] device Pointer to iSCSI device to enqueue - * the task to and may NOT be NULL, so be - * careful. - * @param[in] scsi_task Pointer to iSCSI SCSI task to enqueue - * to the associated device. NULL is not - * allowed here, take caution. - */ -void iscsi_device_scsi_task_queue(iscsi_device *device, iscsi_scsi_task *scsi_task) -{ - iscsi_scsi_lun_task_exec( scsi_task->lun, scsi_task ); -} - -/** - * @brief Checks if an iSCSI target node NAA or EUI hex identifier is valid. - * - * This function checks if the NAA or - * EUI onlycontains only valid - * hexadecimal characters. - * - * @param[in] name Pointer to NAA or EUI name string - * to be validated, may NOT be NULL, so - * be careful. - * @param[in] pos Position of the hexadecimal string - * to validate. - * @param[in] len Length of the hexadecimal string - * to validate. - * @retval true The NAA or EUI format is valid. - * @retval false The NAA or EUI format is invalid. - */ -static bool iscsi_target_node_check_hex(const uint8_t *name, const size_t pos, const size_t len) -{ - for ( size_t i = pos; i < len; i++ ) { - const uint8_t c = name[i]; - - if ( (c < '0') || ((c > '9') && (c < 'A')) || ((c > 'F') && (c < 'a')) || (c > 'f') ) - return false; - } - - return true; -} - -/** - * @brief Checks if an iSCSI target node name is valid. - * - * This function checks the maximum allowed - * length of the target name and also if it - * contains only valid characters.\n - * If the target name starts with 'iqn.' it - * checks for valid 'iqn.YYYY-MM.' pattern.\n - * If target name starts with 'naa.' or - * 'eui.' instead, it will check if the - * 16 follow up characters are a valid - * hexadecimal string. - * - * @param[in] name Pointer to target name string to be - * validated, may NOT be NULL, so be - * careful. - * @return 0 if all checks passed successfully, - * a negative error code otherwise. - */ -static int iscsi_target_node_check_name(const uint8_t *name) -{ - if ( iscsi_globvec->target_name_check == ISCSI_GLOBALS_TARGET_NAME_CHECK_NONE ) - return 0; - - const size_t len = strlen( (char *) name ); - - if ( len > ISCSI_TARGET_NODE_MAX_NAME_LEN ) - return -1; - - if ( (iscsi_globvec->target_name_check == ISCSI_GLOBALS_TARGET_NAME_CHECK_FULL) || (strncasecmp( (char *) name, ISCSI_TARGET_NODE_NAME_IQN_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_IQN_PREFIX) ) == 0) || (strncasecmp( (char *) name, ISCSI_TARGET_NODE_NAME_NAA_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX) ) == 0) || (strncasecmp( (char *) name, ISCSI_TARGET_NODE_NAME_EUI_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_EUI_PREFIX) ) == 0) ) { - for ( size_t i = 0; i < len; i++ ) { - const uint8_t c = name[i]; - - if ( (c <= 0x2CU) || (c == 0x2FU) || ((c >= 0x3BU && c <= 0x40U)) || ((c >= 0x5BU) && (c <= 0x60U)) || ((c >= 0x7BU) && (c <= 0x7FU)) ) - return -1; - } - } - - if ( ((strncasecmp( (char *) name, ISCSI_TARGET_NODE_NAME_IQN_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_IQN_PREFIX) ) == 0) && (!isdigit(name[4]) || !isdigit(name[5]) || !isdigit(name[6]) || !isdigit(name[7]) || (name[8] != '-') || (name[9] < '0') || (name[9] > '1') || ((name[9] == '0') && ((name[10] < '1') && (name[10] > '9'))) || ((name[9] == '1') && ((name[10] < '0') || (name[10] > '2'))) || (name[11] != '.'))) || (((strncasecmp( (char *) name, ISCSI_TARGET_NODE_NAME_NAA_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX) ) == 0) && ((len == (ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX) + 16)) || (len == (ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX) + 32))) && !iscsi_target_node_check_hex( name, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX), len )) || (((strncasecmp( (char *) name, ISCSI_TARGET_NODE_NAME_EUI_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_EUI_PREFIX) ) == 0) && (len == (ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_EUI_PREFIX) + 16))) && !iscsi_target_node_check_hex( name, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_EUI_PREFIX), len ))) ) - return -1; - - return 0; -} - -/** - * @brief Checks if the iSCSI target node flags are valid. - * - * This function checks if the set flags - * are contradicting themselves or are - * okay. - * - * @param[in] flags Target node flags to check. - * @param[in] chap_group CHAP group to check. - * @return 0 if flags are valid, a negative - * error code otherwise. - */ -static int iscsi_target_node_check_flags(const int flags, const int32_t chap_group) -{ - if ( chap_group < 0L ) - return -1; - - if ( (((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_DISABLE) == 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_REQUIRE) == 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_MUTUAL) == 0)) || // Auto - (((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_DISABLE) != 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_REQUIRE) == 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_MUTUAL) == 0)) || // None - (((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_DISABLE) == 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_REQUIRE) != 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_MUTUAL) == 0)) || // CHAP - (((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_DISABLE) == 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_REQUIRE) != 0) && ((flags & ISCSI_TARGET_NODE_FLAGS_CHAP_MUTUAL) != 0)) ) // CHAP Mutual - return 0; - - return -1; -} - -/** - * @brief Creates, initializes and adds a portal group to an iSCSI target node. - * - * Callback function for each element while iterating - * through the iSCSI global vector portal group - * hash map. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL creates an - * empty key assignment. - * @param[in,out] user_data Pointer to the iSCSI target - * node to be added and may NOT be NULL, so be - * careful. - * @retval -1 An error occured during adding the - * iSCSI portal group to the iSCSI target node. - * @retval 0 The iSCSI portal group has been - * added successfully. - */ -int iscsi_target_node_create_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_target_node *target = (iscsi_target_node *) user_data; - iscsi_portal_group *portal_group = (iscsi_portal_group *) value; - uint8_t *port_name = iscsi_sprintf_alloc( "%s,t,0x%4.4" PRIx64, target->device->name, portal_group->tag ); - - if ( port_name == NULL ) - return -1; - - const int rc = iscsi_device_port_add( target->device, port_name, (uint64_t) portal_group->tag ); - - free( port_name ); - - return rc; -} - -/** - * @brief Creates and initializes an iSCSI target node. - * - * This function also allocates the underlying SCSI - * device and always initializes the first LUN. - * - * @param[in] name Pointer to IQN name of target node, - * may NOT be NULL, so be careful. - * @param[in] alias Pointer to alias of IQN name. - * @param[in] index Target node index number. - * @param[in] lun_id LUN identifier to associate with underlying SCSI device. - * @param[in] queue_depth Maximum queue depth. - * @param[in] flags Flags for this target node. - * @param[in] chap_group CHAP group to associate this node with. - * @param[in] header_digest Header digest size (always MUST be 0 or 4 for now). - * @param[in] data_digest Data digest size (always MUST be 0 or 4 for now). - * @return Pointer to iSCSI target node on successful - * operation or NULL in case of an error. - */ -iscsi_target_node *iscsi_target_node_create(uint8_t *name, const uint8_t *alias, const int index, const int lun_id, const uint queue_depth, const int flags, const int32_t chap_group, const int header_digest, const int data_digest) -{ - if ( (name == NULL) || (iscsi_target_node_check_name( name ) < 0) || (iscsi_target_node_check_flags( flags, chap_group ) < 0) ) - return NULL; - - iscsi_target_node *target = (iscsi_target_node *) malloc( sizeof(struct iscsi_target_node) ); - - if ( target == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_create: Out of memory allocating iSCSI target node" ); - - return NULL; - } - - const uint name_len = (uint) (strlen( (char *) name ) + 1U); - - target->name = malloc( name_len ); - - if ( target->name == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_create: Out of memory allocating iSCSI target node name" ); - - free( target ); - - return NULL; - } - - memcpy( target->name, name, name_len ); - - if ( alias != NULL ) { - const uint alias_len = (uint) (strlen( (char *) alias ) + 1U); - - target->alias = malloc( alias_len ); - - if ( target->alias == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_create: Out of memory allocating iSCSI target node alias" ); - - free( target->name ); - free( target ); - - return NULL; - } - - memcpy( target->alias, alias, alias_len ); - } else { - target->alias = NULL; - } - - dnbd3_image_t *image = iscsi_target_node_image_get( name ); - - if ( image == NULL ) { - if ( target->alias != NULL ) - free( target->alias ); - - free( target->name ); - free( target ); - - return NULL; - } - - const uint key_len = (uint) (strlen( (char *) image->name ) + 1U); - uint8_t *hash_key = iscsi_hashmap_key_create( (uint8_t *) image->name, key_len ); - iscsi_device *device = NULL; - - pthread_rwlock_wrlock( &iscsi_globvec->devices_rwlock ); - int rc = iscsi_hashmap_get( iscsi_globvec->devices, hash_key, key_len, (uint8_t **) &device ); - - if ( device != NULL ) { - pthread_rwlock_wrlock( &device->luns_rwlock ); - - iscsi_scsi_lun *lun = iscsi_device_find_lun( device, lun_id ); - - if ( lun == NULL ) { - lun = iscsi_scsi_lun_create( lun_id ); - - if ( lun == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_create: Out of memory allocating iSCSI device LUN hash map" ); - - pthread_rwlock_unlock( &device->luns_rwlock ); - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - iscsi_hashmap_key_destroy( hash_key ); - - if ( target->alias != NULL ) - free( target->alias ); - - free( target->name ); - free( target ); - - return NULL; - } - - const uint64_t lun_hash = lun_id; - uint8_t *lun_hash_key = iscsi_hashmap_key_create( (uint8_t *) &lun_hash, sizeof(lun_hash) ); - - if ( lun_hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_create: Out of memory allocating iSCSI device LUN hash map" ); - - pthread_rwlock_unlock( &device->luns_rwlock ); - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - iscsi_scsi_lun_destroy( lun ); - iscsi_hashmap_key_destroy( hash_key ); - - if ( target->alias != NULL ) - free( target->alias ); - - free( target->name ); - free( target ); - - return NULL; - } - - const int rc = iscsi_hashmap_put( device->luns, lun_hash_key, sizeof(lun_hash), (uint8_t *) lun ); - - if ( rc < 0 ) { - pthread_rwlock_unlock( &device->luns_rwlock ); - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - iscsi_hashmap_key_destroy( lun_hash_key ); - iscsi_scsi_lun_destroy( lun ); - iscsi_hashmap_key_destroy( hash_key ); - - if ( target->alias != NULL ) - free( target->alias ); - - free( target->name ); - free( target ); - - return NULL; - } - } - - pthread_rwlock_unlock( &device->luns_rwlock ); - iscsi_hashmap_key_destroy( hash_key ); - - hash_key = NULL; - } else { - device = iscsi_device_create( (uint8_t *) image->name, lun_id, ISCSI_TRANSPORT_ID_PROTOCOL_ID_ISCSI ); - - if ( device == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_create: Out of memory allocating iSCSI target device" ); - - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - iscsi_hashmap_key_destroy( hash_key ); - - if ( target->alias != NULL ) - free( target->alias ); - - free( target->name ); - free( target ); - - return NULL; - } - - rc = iscsi_hashmap_put( iscsi_globvec->devices, hash_key, key_len, (uint8_t *) device ); - - if ( rc < 0 ) { - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - iscsi_device_destroy( device ); - iscsi_hashmap_key_destroy( hash_key ); - - if ( target->alias != NULL ) - free( target->alias ); - - free( target->name ); - free( target ); - - return NULL; - } - } - - device->active_conns++; - - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - - target->device = device; - - pthread_rwlock_rdlock( &iscsi_globvec->portal_groups_rwlock ); - rc = iscsi_hashmap_iterate( iscsi_globvec->portal_groups, iscsi_target_node_create_callback, (uint8_t *) target ); - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - - if ( rc < 0 ) { - if ( hash_key != NULL ) { - pthread_rwlock_wrlock( &iscsi_globvec->devices_rwlock ); - iscsi_hashmap_remove( iscsi_globvec->devices, hash_key, key_len ); - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - iscsi_device_destroy( device ); - iscsi_hashmap_key_destroy( hash_key ); - } else { - pthread_rwlock_wrlock( &iscsi_globvec->devices_rwlock ); - - device->active_conns--; - - pthread_rwlock_unlock( &iscsi_globvec->devices_rwlock ); - } - - if ( target->alias != NULL ) - free( target->alias ); - - free( target->name ); - free( target ); - - return NULL; - } - - target->num = index; - target->queue_depth = queue_depth; - target->flags = flags; - target->header_digest = header_digest; - target->data_digest = data_digest; - target->chap_group = chap_group; - target->active_conns = 0UL; - - return target; -} - -/** - * @brief iSCSI target node destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * target node stored in the hash map managing all - * iSCSI target nodes. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_target_node_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_target_node_destroy( (iscsi_target_node *) value ); - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** - * @brief Deallocates all resources acquired by iscsi_target_node_create. - * - * This function also frees the IQN name, - * IQN alias and the associated SCSI device. - * - * @param[in] target Pointer to iSCSI target node to be freed. - * May be NULL in which case this function - * does nothing at all. - */ -void iscsi_target_node_destroy(iscsi_target_node *target) -{ - if ( target != NULL ) { - if ( target->alias != NULL ) { - free( target->alias ); - - target->alias = NULL; - } - - if ( target->name != NULL ) { - free( target->name ); - - target->name = NULL; - } - - free( target ); - } -} - -/** - * @brief Sends a buffer from a source iSCSI IQN to target iSCSI IQNs. - * - * This function sends a buffer starting from a - * specified position to one, multiple or all - * target IQNs.\n - * This function also checks the input and output - * IQN for conforming to iSCSI specifications. - * - * @param[in] conn Pointer to iSCSI connection to write the buffer. - * @param[in] dst_iqn Pointer to string containing the target IQNs, - * NULL is not allowed here, take caution. - * @param[in] src_iqn Pointer to string containing the source IQN. - * May NOT be NULL, so be careful. - * @param[in] buf Pointer to output buffer. - * @param[in] pos Position in buffer in bytes to start sending. - * @param[in] len Length of buffer in bytes. - * @return The new position of the written data or a - * negative error code otherwise. - */ -int32_t iscsi_target_node_send(iscsi_connection *conn, const uint8_t *dst_iqn, const uint8_t *src_iqn, uint8_t *buf, const uint32_t pos, const uint32_t len) -{ - // TODO: Implement function. - - return -1; -} - -/** * @brief Calculates the WWN using 64-bit IEEE Extended NAA for a name. * * @param[in] name Pointer to string containing the @@ -8677,7 +2394,7 @@ int32_t iscsi_target_node_send(iscsi_connection *conn, const uint8_t *dst_iqn, c * @return A 64-bit unsigned integer for * storing the IEEE Extended NAA. */ -uint64_t iscsi_target_node_wwn_get(const uint8_t *name) +static uint64_t iscsi_target_node_wwn_get(const uint8_t *name) { uint64_t value = 0ULL; int i = 0; @@ -8692,257 +2409,6 @@ uint64_t iscsi_target_node_wwn_get(const uint8_t *name) } /** - * @brief Extracts the DNBD3 image out of an iSCSI IQN string and opens the DNBD3 image. - * - * This function uses the : separator as - * specified by the IQN standard.\n - * If no colons are in the IQN string, - * the complete string will be - * considered the image file name.\n - * The image file name is assumed - * before the last colon and is - * either directly opened or if - * that fails, a WWN name by - * IEEE Extended NAA is tried as - * well.\n - * The image revision is assumed - * after the last colon. - * @param[in] iqn Pointer to iSCSI IQN string. This - * is not allowed to be NULL, so be careful. - * @return Pointer to DNBD3 image if successful - * operation or NULL if failed. - */ -dnbd3_image_t *iscsi_target_node_image_get(uint8_t *iqn) -{ - uint8_t *image_name = iqn; - uint8_t *image_rev = NULL; - uint8_t *tmp = (uint8_t *) strchr( (char *) iqn, ':' ); - - while ( tmp != NULL ) { - tmp++; - - if ( image_rev != NULL ) - image_name = image_rev; - - image_rev = tmp; - tmp = (uint8_t *) strchr( (char *) tmp, ':' ); - } - - if ( image_rev == NULL ) - image_rev = image_name; - - const uint len = (uint) (image_rev - image_name); - - if ( len > 0U ) { - tmp = (uint8_t *) malloc( len ); - - if ( tmp == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_image_get: Out of memory while allocating DNBD3 image name for iSCSI target node" ); - - return NULL; - } - - memcpy( tmp, image_name, (len - 1) ); - tmp[len - 1] = '\0'; - } else { - tmp = image_name; - } - - const uint16_t rev = (uint16_t) ((len > 0U) ? atoi( (char *) image_rev ) : 0); - dnbd3_image_t *image = image_getOrLoad( (char *) image_name, rev ); - - if ( image == NULL ) { - image = image_getOrLoad( (char *) tmp, rev ); - - if ( image == NULL ) { - if ( strncasecmp( (char *) image_name, ISCSI_TARGET_NODE_NAME_WWN_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_WWN_PREFIX) ) == 0 ) { - uint64_t wwn = strtoull( (char *) (image_name + ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_WWN_PREFIX)), NULL, 16 ); - - image = image_getByWwn( wwn, rev, true ); - - if ( image == NULL ) { - wwn = strtoull( (char *) (tmp + ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_WWN_PREFIX)), NULL, 16 ); - image = image_getByWwn( wwn, rev, true ); - } - } else if ( strncasecmp( (char *) image_name, ISCSI_TARGET_NODE_NAME_NAA_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX) ) == 0 ) { - uint64_t wwn = strtoull( (char *) (image_name + ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX)), NULL, 16 ); - - image = image_getByWwn( wwn, rev, true ); - - if ( image == NULL ) { - wwn = strtoull( (char *) (tmp + ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_NAA_PREFIX)), NULL, 16 ); - image = image_getByWwn( wwn, rev, true ); - } - } else if ( strncasecmp( (char *) image_name, ISCSI_TARGET_NODE_NAME_EUI_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_EUI_PREFIX) ) == 0 ) { - uint64_t wwn = (0x2ULL << 60ULL) | (strtoull( (char *) (image_name + ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_EUI_PREFIX)), NULL, 16 ) & 0x0FFFFFFFFFFFFFFFULL); - - image = image_getByWwn( wwn, rev, true ); - - if ( image == NULL ) { - wwn = (0x2ULL << 60ULL) | (strtoull( (char *) (tmp + ISCSI_STRLEN(ISCSI_TARGET_NODE_NAME_EUI_PREFIX)), NULL, 16 ) & 0x0FFFFFFFFFFFFFFFULL); - image = image_getByWwn( wwn, rev, true ); - } - } - } - } - - if ( len > 0U ) - free( tmp ); - - return image; -} - -/** - * @brief Finds an iSCSI target node by case insensitive name search. - * - * Callback function for each element while iterating - * through the iSCSI target nodes. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL creates an - * empty key assignment. - * @param[in,out] user_data Pointer to a data structure - * containing the iSCSI target node and the name to be - * searched for and may NOT be NULL, so be careful. - * @retval -1 The target node has been found and stored - * in the result structure. Therefore, no further - * searching is needed. - * @retval 0 The target node has not been found yet. - */ -int iscsi_target_node_find_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_target_node_find_name *target_find = (iscsi_target_node_find_name *) user_data; - iscsi_target_node *target = (iscsi_target_node *) value; - - if ( strcasecmp( (char *) target->name, (char *) target_find->name ) != 0 ) - return 0; - - target_find->target = target; - - return -1; -} - -/** - * @brief Searches an iSCSI target node by name using case insensitive search. - * - * This function searches for an iSCSI target node - * by iterating through the iSCSI global target node - * hash map. - * - * @param[in] target_name Pointer to string containing the name - * of the iSCSI target node to be searched for. - * @return Pointer to found iSCSI target node or NULL - * in case no iSCSI target node has a matching name. - */ -iscsi_target_node *iscsi_target_node_find(uint8_t *target_name) -{ - if ( target_name == NULL ) - return NULL; - - iscsi_target_node_find_name target_find = {NULL, target_name}; - - pthread_rwlock_wrlock( &iscsi_globvec->target_nodes_rwlock ); - iscsi_hashmap_iterate( iscsi_globvec->target_nodes, iscsi_target_node_find_callback, (uint8_t *) &target_find ); - - iscsi_target_node *target = target_find.target; - - if ( target == NULL ) { - dnbd3_image_t *image = iscsi_target_node_image_get( target_name ); - - if ( image == NULL ) { - pthread_rwlock_unlock( &iscsi_globvec->target_nodes_rwlock ); - - return NULL; - } - - target = iscsi_target_node_create( target_name, NULL, 0, image->rid, 16U, 0, 0L, 0, 0 ); - - if ( target == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_find: Out of memory while allocating iSCSI target node" ); - - pthread_rwlock_unlock( &iscsi_globvec->target_nodes_rwlock ); - - return NULL; - } - - const uint key_len = (uint) (strlen( (char *) target_name ) + 1U); - uint8_t *hash_key = iscsi_hashmap_key_create( target_name, key_len ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_target_node_find: Out of memory while allocating iSCSI target node" ); - - pthread_rwlock_unlock( &iscsi_globvec->target_nodes_rwlock ); - iscsi_target_node_destroy( target ); - - return NULL; - } - - int rc = iscsi_hashmap_put( iscsi_globvec->target_nodes, (uint8_t *) hash_key, key_len, (uint8_t *) target ); - - if ( rc < 0 ) { - pthread_rwlock_unlock( &iscsi_globvec->target_nodes_rwlock ); - iscsi_hashmap_key_destroy( (uint8_t *) hash_key ); - iscsi_target_node_destroy( target ); - - return NULL; - } - } - - target->active_conns++; - - pthread_rwlock_unlock( &iscsi_globvec->target_nodes_rwlock ); - - return target; -} - -/** - * @brief Retrieves target node redirection address. - * - * This function checks whether the target node needs - * a redirect and is used for informing the client - * about a necessary redirection. - * - * @param[in] conn Pointer to iSCSI connection, may NOT - * be NULL, so be careful. - * @param[in] target Pointer to iSCSI target node where - * NULL is NOT allowed, so take caution. - * @return Pointer to redirect target address or NULL - * if no redirection. - */ -uint8_t *iscsi_target_node_get_redirect(iscsi_connection *conn, iscsi_target_node *target) -{ - // TODO: Implement function - - return NULL; -} - -/** - * @brief Checks if target node is accessible. - * - * This function checks whether access is possible - * to a specific iSCSI IQN and IP address. - * - * @param[in] conn Pointer to iSCSI connection which - * may NOT be NULL, so be careful. - * @param[in] target Pointer to iSCSI target node. NULL - * is not allowed here, to take caution. - * @param[in] iqn Pointer to iSCSI IQN string. This - * is not allowed to be NULL, so be careful. - * @param[in] adr Pointer to IP address, NULL is not - * allowed, so take care. - * @return 0 if access is possible, a negative error - * code otherwise. - */ -int iscsi_target_node_access(iscsi_connection *conn, iscsi_target_node *target, const uint8_t *iqn, const uint8_t *adr) -{ - // TODO: Implement access check function - - return 0; -} - -/** * @brief Creates and initializes an iSCSI session. * * This function creates and initializes all relevant @@ -8952,14 +2418,13 @@ int iscsi_target_node_access(iscsi_connection *conn, iscsi_target_node *target, * login phase. * * @param[in] conn Pointer to iSCSI connection to associate with the session. - * @param[in] target Pointer to iSCSI target node to assign with the session. * @param[in] type Session type to initialize the session with. * @return Pointer to initialized iSCSI session or NULL in case an error * occured (usually due to memory exhaustion). */ -iscsi_session *iscsi_session_create(iscsi_connection *conn, iscsi_target_node *target, const int type) +static iscsi_session *iscsi_session_create(iscsi_connection *conn, const int type) { - iscsi_session *session = (iscsi_session *) malloc( sizeof(struct iscsi_session) ); + iscsi_session *session = malloc( sizeof(struct iscsi_session) ); if ( session == NULL ) { logadd( LOG_ERROR, "iscsi_session_create: Out of memory allocating iSCSI session" ); @@ -8967,104 +2432,16 @@ iscsi_session *iscsi_session_create(iscsi_connection *conn, iscsi_target_node *t return NULL; } - session->tag = conn->pg_tag; - session->flags = 0; - - if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_INIT_R2T) != 0 ) - session->flags |= ISCSI_SESSION_FLAGS_INIT_R2T; - - if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA) != 0 ) - session->flags |= ISCSI_SESSION_FLAGS_IMMEDIATE_DATA; - - if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER) != 0 ) - session->flags |= ISCSI_SESSION_FLAGS_DATA_PDU_IN_ORDER; - - if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER) != 0 ) - session->flags |= ISCSI_SESSION_FLAGS_DATA_SEQ_IN_ORDER; - - session->conns = 1UL; - session->max_conns = iscsi_globvec->max_session_conns; - session->max_outstanding_r2t = iscsi_globvec->max_outstanding_r2t; - session->default_time_to_wait = iscsi_globvec->default_time_to_wait; - session->default_time_to_retain = iscsi_globvec->default_time_to_retain; - session->first_burst_len = iscsi_globvec->first_burst_len; - session->max_burst_len = iscsi_globvec->max_burst_len; - session->err_recovery_level = iscsi_globvec->err_recovery_level; - - iscsi_list_create( &session->conn_list ); - iscsi_list_enqueue( &session->conn_list, &conn->node ); - - session->key_value_pairs = iscsi_hashmap_create( ((sizeof(iscsi_session_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1) ); - - if ( session->key_value_pairs == NULL ) { - logadd( LOG_ERROR, "iscsi_session_create: Out of memory allocating iSCSI session key and value pairs hash map" ); - - free( session ); - - return NULL; - } - - session->target = target; - session->isid = 0ULL; session->tsih = 0ULL; - session->queue_depth = 0U; session->type = type; session->exp_cmd_sn = 0UL; session->max_cmd_sn = 0UL; session->current_text_init_task_tag = 0xFFFFFFFFUL; - int rc = iscsi_session_init_key_value_pairs( session->key_value_pairs ); - rc |= iscsi_update_int_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_CONNECTIONS, session->max_conns ); - rc |= iscsi_update_int_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_OUTSTANDING_R2T, session->max_outstanding_r2t ); - rc |= iscsi_update_int_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_WAIT, session->default_time_to_wait ); - rc |= iscsi_update_int_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_RETAIN, session->default_time_to_retain ); - rc |= iscsi_update_int_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_FIRST_BURST_LEN, session->first_burst_len ); - rc |= iscsi_update_int_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN, session->max_burst_len ); - rc |= iscsi_update_bool_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_INITIAL_R2T, (session->flags & ISCSI_SESSION_FLAGS_INIT_R2T) ); - rc |= iscsi_update_bool_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IMMEDIATE_DATA, (session->flags & ISCSI_SESSION_FLAGS_IMMEDIATE_DATA) ); - rc |= iscsi_update_bool_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_PDU_IN_ORDER, (session->flags & ISCSI_SESSION_FLAGS_DATA_PDU_IN_ORDER) ); - rc |= iscsi_update_bool_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_SEQ_IN_ORDER, (session->flags & ISCSI_SESSION_FLAGS_DATA_SEQ_IN_ORDER) ); - rc |= iscsi_update_int_key_value_pair( session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_ERR_RECOVERY_LEVEL, session->err_recovery_level ); - rc |= iscsi_update_int_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_RECV_DS_LEN, conn->max_recv_ds_len ); - - if ( rc != 0 ) { - logadd( LOG_ERROR, "iscsi_session_create: Out of memory adding iSCSI session key and integer value pair" ); - - iscsi_hashmap_iterate( session->key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( session->key_value_pairs ); - free( session ); - - return NULL; - } - return session; } /** - * @brief iSCSI session destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * session stored in the hash map managing all iSCSI - * sessions. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_session_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_session_destroy( (iscsi_session *) value ); - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** * @brief Deallocates all resources acquired by iscsi_session_create. * * This function also frees the associated key and value pairs, @@ -9074,80 +2451,9 @@ int iscsi_session_destroy_callback(uint8_t *key, const size_t key_size, uint8_t * @param[in] session Pointer to iSCSI session to be freed. * May be NULL in which case this function does nothing at all. */ -void iscsi_session_destroy(iscsi_session *session) +static void iscsi_session_destroy(iscsi_session *session) { - if ( session != NULL ) { - session->tag = 0ULL; - session->target = NULL; - session->type = ISCSI_SESSION_TYPE_INVALID; - - if ( session->key_value_pairs != NULL ) { - iscsi_hashmap_iterate( session->key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( session->key_value_pairs ); - - session->key_value_pairs = NULL; - } - - iscsi_connection *conn; - iscsi_connection *tmp; - - iscsi_list_foreach_safe_node ( &session->conn_list, conn, tmp ) { - iscsi_list_remove( &conn->node ); - iscsi_connection_destroy( conn ); - } - - if ( session->init_port != NULL ) { - iscsi_port_destroy( session->init_port ); - - session->init_port = NULL; - } - - free( session ); // TODO: Check if potential reusage of session makes sense. - } -} - -/** - * @brief Initializes a key and value pair hash table with default values. - * - * This function is used by iSCSI connections and - * sessions with default values for required keys.\n - * The iSCSI global key and value pair allowed - * values and ranges for fast - * access - * - * @param[in] key_value_pairs Pointer to key and value pair hash map - * which should store all the default values for - * its keys and may NOT be NULL, so take caution. - * @param[in] lut Lookup table to use for initialization. - * NULL is not allowed here, so be careful. - * @return 0 on success, a negative error code otherwise. - */ -static int iscsi_init_key_value_pairs(iscsi_hashmap *key_value_pairs, const iscsi_key_value_pair_lut_entry *lut) -{ - for ( uint i = 0U; lut[i].key != NULL; i++ ) { - const int rc = iscsi_add_key_value_pair( key_value_pairs, lut[i].key, lut[i].value ); - - if ( rc < 0 ) - return rc; - } - - return 0; -} - -/** - * @brief Initializes a key and value pair hash table with default values for an iSCSI session. - * - * This function only initializes the default key - * and value pairs used by iSCSI sessions. - * - * @param[in] key_value_pairs Pointer to key and value pair hash map - * which should store all the default values for - * its keys and may NOT be NULL, so take caution. - * @return 0 on success, a negative error code otherwise. - */ -int iscsi_session_init_key_value_pairs(iscsi_hashmap *key_value_pairs) -{ - return iscsi_init_key_value_pairs( key_value_pairs, &iscsi_session_key_value_pair_lut[0] ); + free( session ); } /** @@ -9156,15 +2462,13 @@ int iscsi_session_init_key_value_pairs(iscsi_hashmap *key_value_pairs) * Creates a data structure for incoming iSCSI connection * requests from iSCSI packet data. * - * @param[in] portal Pointer to iSCSI portal to associate the - * connection with. - * @param[in] sock TCP/IP socket to associate the connection with. + * @param[in] client dnbd3 client to associate the connection with. * @return Pointer to initialized iSCSI connection structure or NULL in * case of an error (invalid iSCSI packet data or memory exhaustion). */ -iscsi_connection *iscsi_connection_create(iscsi_portal *portal, const int sock) +static iscsi_connection *iscsi_connection_create(dnbd3_client_t *client) { - iscsi_connection *conn = (iscsi_connection *) malloc( sizeof(struct iscsi_connection) ); + iscsi_connection *conn = malloc( sizeof(struct iscsi_connection) ); if ( conn == NULL ) { logadd( LOG_ERROR, "iscsi_create_connection: Out of memory while allocating iSCSI connection" ); @@ -9172,187 +2476,27 @@ iscsi_connection *iscsi_connection_create(iscsi_portal *portal, const int sock) return NULL; } - conn->session = NULL; - conn->key_value_pairs = iscsi_hashmap_create( ((sizeof(iscsi_connection_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1) ); - - if ( conn->key_value_pairs == NULL ) { - logadd( LOG_ERROR, "iscsi_create_connection: Out of memory while allocating iSCSI login text key / value pair hash map" ); - - free( conn ); - - return NULL; - } - - const int rc = iscsi_connection_init_key_value_pairs( conn->key_value_pairs ); - - if ( rc < 0 ) { - iscsi_hashmap_iterate( conn->key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->key_value_pairs ); - free( conn ); - - return NULL; - } - - conn->partial_pairs = NULL; - conn->text_key_value_pairs = iscsi_hashmap_create( ((sizeof(iscsi_connection_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1) ); - - if ( conn->text_key_value_pairs == NULL ) { - logadd( LOG_ERROR, "iscsi_create_connection: Out of memory while allocating iSCSI text key / value pair hash map" ); - - iscsi_hashmap_iterate( conn->key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->key_value_pairs ); - free( conn ); - - return NULL; - } - - conn->text_partial_pairs = NULL; - conn->device = NULL; - conn->init_port = NULL; - conn->init_name = NULL; - conn->init_adr = NULL; - conn->target = NULL; - conn->target_port = NULL; - conn->target_name_short = NULL; - conn->portal_host = NULL; - conn->portal_port = NULL; - conn->pdu_processing = NULL; - - iscsi_list_create( &conn->scsi_data_in_queued_tasks ); - - conn->login_response_pdu = NULL; - - iscsi_list_create( &conn->pdus_write ); - iscsi_list_create( &conn->pdus_snack ); - iscsi_list_create( &conn->r2t_tasks_active ); - iscsi_list_create( &conn->r2t_tasks_queue ); - - conn->target_send_total_size = 0U; - conn->scsi_data_in_cnt = 0U; - conn->scsi_data_out_cnt = 0U; - conn->task_cnt = 0U; - conn->r2t_pending = 0U; - conn->header_digest = 0; - conn->data_digest = 0; + conn->session = NULL; + conn->pdu_processing = NULL; + conn->login_response_pdu = NULL; conn->id = 0; - conn->sock = sock; + conn->client = client; conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_READY; conn->flags = 0; conn->state = ISCSI_CONNECT_STATE_INVALID; conn->login_phase = ISCSI_LOGIN_RESPONSE_FLAGS_NEXT_STAGE_SECURITY_NEGOTIATION; - conn->max_recv_ds_len = ISCSI_DEFAULT_RECV_DS_LEN; - conn->pg_tag = portal->group->tag; - conn->isid.a = 0; - conn->isid.b = 0; - conn->isid.c = 0; - conn->isid.d = 0; conn->tsih = 0U; conn->cid = 0U; conn->state_negotiated = 0U; conn->session_state_negotiated = 0UL; conn->init_task_tag = 0UL; conn->target_xfer_tag = 0UL; - conn->auth_chap.phase = ISCSI_AUTH_CHAP_PHASE_NONE; - conn->chap_group = 0L; conn->stat_sn = 0UL; - conn->exp_stat_sn = 0UL; - - iscsi_list_create( &conn->exec_queue ); - - conn->stat_iscsi_opcodes = iscsi_hashmap_create( 256U ); - - if ( conn->stat_iscsi_opcodes == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing iSCSI global vector iSCSI opcode statistics" ); - - iscsi_hashmap_destroy( conn->text_key_value_pairs ); - iscsi_hashmap_iterate( conn->key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->key_value_pairs ); - free( conn ); - - return NULL; - } - - conn->stat_scsi_opcodes = iscsi_hashmap_create( 256U ); - - if ( conn->stat_scsi_opcodes == NULL ) { - logadd( LOG_ERROR, "iscsi_create: Out of memory while initializing iSCSI global vector iSCSI SCSI opcode statistics" ); - - iscsi_hashmap_destroy( conn->stat_iscsi_opcodes ); - iscsi_hashmap_destroy( conn->text_key_value_pairs ); - iscsi_hashmap_iterate( conn->key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->key_value_pairs ); - free( conn ); - - return NULL; - } return conn; } /** - * @brief Deallocates all pending iSCSI tasks and PDUs associated with an iSCSI connection. - * - * This function only removes tasks which are - * not enqueued. - * - * @param[in] conn Pointer to iSCSI connection of which to - * deallocate all the tasks and PDUs. May NOT - * be NULL, so be careful. - */ -static int iscsi_connection_tasks_destroy(iscsi_connection *conn) -{ - iscsi_pdu *pdu; - iscsi_pdu *tmp_pdu; - - iscsi_list_foreach_safe_node ( &conn->pdus_snack, pdu, tmp_pdu ) { - iscsi_list_remove( &pdu->node ); - iscsi_connection_pdu_destroy( pdu ); - } - - iscsi_task *task; - iscsi_task *tmp_task; - - iscsi_list_foreach_safe_node ( &conn->scsi_data_in_queued_tasks, task, tmp_task ) { - if ( (task->flags & ISCSI_TASK_FLAGS_QUEUED) != 0 ) - continue; - - iscsi_list_remove( &task->node ); - iscsi_task_destroy( task ); - } - - iscsi_list_foreach_safe_node ( &conn->pdus_write, pdu, tmp_pdu ) { - iscsi_list_remove( &pdu->node ); - iscsi_connection_pdu_destroy( pdu ); - } - - return ((conn->task_cnt != 0) ? -1 : 0); -} - -/** - * @brief iSCSI connection destructor callback for hash map. - * - * Callback function for deallocation of an iSCSI - * connection stored in the hash map managing all - * iSCSI connections. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data This argument is not used by - * this function and should be always NULL for now, as - * there is a possibility for future usage. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_connection_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_connection_destroy( (iscsi_connection *) value ); - iscsi_hashmap_key_destroy( key ); - - return 0; -} - -/** * @brief Deallocates all resources acquired by iscsi_connection_create. * * Deallocates a data structure of an iSCSI connection @@ -9365,144 +2509,16 @@ int iscsi_connection_destroy_callback(uint8_t *key, const size_t key_size, uint8 * function, use iscsi_connection_close for this. This may be * NULL in which case this function does nothing. */ -void iscsi_connection_destroy(iscsi_connection *conn) +static void iscsi_connection_destroy(iscsi_connection *conn) { if ( conn != NULL ) { - iscsi_hashmap_iterate( conn->stat_scsi_opcodes, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->stat_scsi_opcodes ); - conn->stat_scsi_opcodes = NULL; - - iscsi_hashmap_iterate( conn->stat_iscsi_opcodes, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->stat_iscsi_opcodes ); - conn->stat_iscsi_opcodes = NULL; - - iscsi_task *task; - iscsi_task *tmp; - - iscsi_list_foreach_safe_node ( &conn->r2t_tasks_queue, task, tmp ) { - iscsi_list_remove( &task->node ); - iscsi_task_destroy( task ); - } - - iscsi_list_foreach_safe_node ( &conn->r2t_tasks_active, task, tmp ) { - iscsi_list_remove( &task->node ); - iscsi_task_destroy( task ); - } - - iscsi_pdu *pdu; - iscsi_pdu *tmp_pdu; - - iscsi_list_foreach_safe_node ( &conn->pdus_snack, pdu, tmp_pdu ) { - iscsi_list_remove( &pdu->node ); - iscsi_connection_pdu_destroy( pdu ); - } - - iscsi_list_foreach_safe_node ( &conn->pdus_write, pdu, tmp_pdu ) { - iscsi_list_remove( &pdu->node ); - iscsi_connection_pdu_destroy( pdu ); - } - - iscsi_list_foreach_safe_node ( &conn->scsi_data_in_queued_tasks, task, tmp ) { - iscsi_list_remove( &task->node ); - iscsi_task_destroy( task ); - } - - if ( conn->pdu_processing != NULL ) { - iscsi_connection_pdu_destroy( conn->pdu_processing ); - - conn->pdu_processing = NULL; - } - - if ( conn->portal_port != NULL ) { - free( conn->portal_port ); - - conn->portal_port = NULL; - } - - if ( conn->portal_host != NULL ) { - free( conn->portal_host ); - - conn->portal_host = NULL; - } - - if ( conn->target_name_short != NULL ) { - free( conn->target_name_short ); - - conn->target_name_short = NULL; - } - - if ( conn->init_adr != NULL ) { - free( conn->init_adr ); - - conn->init_adr = NULL; - } - - if ( conn->init_name != NULL ) { - free( conn->init_name ); - - conn->init_name = NULL; - } - - if ( conn->text_partial_pairs != NULL ) { - free( conn->text_partial_pairs ); - - conn->text_partial_pairs = NULL; - } - - if ( conn->text_key_value_pairs != NULL ) { - iscsi_hashmap_iterate( conn->text_key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->text_key_value_pairs ); - - conn->text_key_value_pairs = NULL; - } - - if ( conn->partial_pairs != NULL ) { - free( conn->partial_pairs ); - - conn->partial_pairs = NULL; - } - - if ( conn->key_value_pairs != NULL ) { - iscsi_hashmap_iterate( conn->key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( conn->key_value_pairs ); - - conn->key_value_pairs = NULL; - } - + iscsi_session_destroy( conn->session ); + iscsi_connection_pdu_destroy( conn->pdu_processing ); free( conn ); } } /** - * @brief Drops all connections based on matching pattern. - * - * @param[in] conn Pointer to iSCSI connection which may - * NOT be NULL, so be careful. - * @param[in] conn_match Pointer to match string, NULL is - * not allowd here, so take caution. - * @param[in] all Non-zero number indicating removing all - * connections. - * @return 0 on success, a negative error code otherwise. - */ -int iscsi_connection_drop(iscsi_connection *conn, const uint8_t *conn_match, const int all) -{ - // TODO: Implement function. - - return 0; -} - -/** - * @brief Schedules an iSCSI connection. - * - * @param[in] conn Pointer to ISCSI connection to be - * scheduled. May NOT be NULL, so be careful. - */ -void iscsi_connection_schedule(iscsi_connection *conn) -{ - // TODO: Implement function. -} - -/** * @brief Reads data for the specified iSCSI connection from its TCP socket. * * The TCP socket is marked as non-blocking, so this function @@ -9514,176 +2530,19 @@ void iscsi_connection_schedule(iscsi_connection *conn) * * Otherwise returns the number of bytes successfully read. */ -int32_t iscsi_connection_read(const iscsi_connection *conn, uint8_t *buf, const uint32_t len) +static int32_t iscsi_connection_read(const iscsi_connection *conn, uint8_t *buf, const uint32_t len) { if ( len == 0UL ) return 0L; - const int32_t rc = (int32_t) recv( conn->sock, buf, (size_t) len, MSG_WAITALL ); - - return ((rc > 0L) ? rc : (int32_t) ISCSI_CONNECT_PDU_READ_ERR_FATAL); -} - -/** - * @brief Writes data for the specified iSCSI connection to its TCP socket. - * - * The TCP socket is marked as non-blocking, so this function may not read - * all data requested. - * - * Returns ISCSI_CONNECT_PDU_READ_ERR_FATAL if the operation - * indicates a fatal error with the TCP connection (including - * if the TCP connection was closed unexpectedly). - * - * Otherwise returns the number of bytes successfully written. - */ -int32_t iscsi_connection_write(const iscsi_connection *conn, uint8_t *buf, const uint32_t len) -{ - if ( len == 0UL ) - return 0L; - - const int32_t rc = (int32_t) sock_sendAll( conn->sock, buf, (size_t) len, ISCSI_CONNECT_SOCKET_WRITE_RETRIES ); - - return ((rc > 0L) ? rc : (int32_t) ISCSI_CONNECT_PDU_READ_ERR_FATAL); -} - -/** - * @brief This function handles all queued iSCSI SCSI Data In tasks. - * - * This function also creates a sub task - * if the data transfer length exceeds - * the maximum allowed chunk size. - * - * @param[in] conn Pointer to iSCSI connection of which the - * queued SCSI Data In tasks should be - * handled. May NOT be NULL, so be careful. - * @return 0 on successful task handling, a - * negative error code otherwise. - */ -int iscsi_connection_handle_scsi_data_in_queued_tasks(iscsi_connection *conn) -{ - while ( !iscsi_list_empty( &conn->scsi_data_in_queued_tasks ) && (conn->scsi_data_in_cnt < ISCSI_DEFAULT_MAX_DATA_IN_PER_CONNECTION) ) { - iscsi_task *task = (iscsi_task *) iscsi_list_peek( &conn->scsi_data_in_queued_tasks ); - - if ( task->pos < task->scsi_task.xfer_len ) { - const uint32_t len = (task->scsi_task.xfer_len - task->pos); - iscsi_task *sub_task = iscsi_task_create( conn, task, iscsi_scsi_task_xfer_complete ); - - if ( sub_task == NULL ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - sub_task->scsi_task.buf = NULL; - sub_task->scsi_task.pos = task->pos; - - pthread_rwlock_rdlock( &conn->device->luns_rwlock ); - - if ( iscsi_device_find_lun( conn->device, task->lun_id ) == NULL ) { - pthread_rwlock_unlock( &conn->device->luns_rwlock ); - - iscsi_list_remove( &task->node ); - - task->pos += len; - sub_task->scsi_task.len = 0UL; - sub_task->scsi_task.xfer_len = len; - - iscsi_scsi_task_lun_process_none( &sub_task->scsi_task ); - iscsi_scsi_task_xfer_complete( &sub_task->scsi_task ); - - return ISCSI_CONNECT_PDU_READ_OK; - } - - pthread_rwlock_unlock( &conn->device->luns_rwlock ); - - sub_task->scsi_task.len = ((len < ISCSI_DEFAULT_MAX_RECV_DS_LEN) ? len : ISCSI_DEFAULT_MAX_RECV_DS_LEN); - task->pos += sub_task->scsi_task.len; - - iscsi_task_queue( conn, sub_task ); - } - - if ( task->pos == task->scsi_task.xfer_len ) - iscsi_list_remove( &task->node ); - } - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Initializes a key and value pair hash table with default values for an iSCSI connection. - * - * This function only initializes the default key - * and value pairs used by iSCSI connectionss. - * - * @param[in] key_value_pairs Pointer to key and value pair hash map - * which should store all the default values for - * its keys and may NOT be NULL, so take caution. - * @return 0 on success, a negative error code otherwise. - */ -int iscsi_connection_init_key_value_pairs(iscsi_hashmap *key_value_pairs) -{ - return iscsi_init_key_value_pairs( key_value_pairs, &iscsi_connection_key_value_pair_lut[0] ); -} - -/** - * @brief Appends a special key and value pair to DataSegment packet data. - * - * This function adds MaxRecvDataSegmentLength, - * FirstBurstLength and MaxBurstLength, which - * require special handling to an output - * DataSegment buffer and truncates if - * necessary. - * - * @param[in] conn Pointer to iSCSI connection to handle the - * special key and value pair for. NULL is - * a forbidden value here, so take caution. - * @param[in] key_value_pair Pointer to special key and value pair - * containing its attributes. - * @param[in] key Pointer to special key to be written to - * output buffer. NULL is NOT allowed, - * take caution. - * @param[in] buf Pointer to output buffer to write the - * special key and value pair to. NULL is - * prohibited, so be careful. - * @param[in] pos Position of buffer in bytes to start - * writing to. - * @param[in] len Total length of buffer in bytes. - * @return New buffer position in bytes or a negative - * error code. - */ -static int32_t iscsi_append_special_key_value_pair_packet(iscsi_connection *conn, iscsi_key_value_pair *key_value_pair, const uint8_t *key, uint8_t *buf, uint32_t pos, const uint32_t len) -{ - if ( key_value_pair == NULL ) - return pos; - - if ( (key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_OVERRIDE_DEFAULT) != 0 ) { - if ( pos >= len ) - return -1L; - - pos += (uint32_t) (snprintf( (char *) (buf + pos), (len - pos), "%s=%" PRId32, key, (uint32_t) ISCSI_DEFAULT_MAX_RECV_DS_LEN ) + 1); - } - - if ( (key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_USE_OTHER_MAX_VALUE) != 0 ) { - if ( pos >= len ) - return -1L; - - uint8_t *first_burst_len_val = NULL; - int rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_FIRST_BURST_LEN, &first_burst_len_val ); - uint32_t first_burst_len = ((rc < 0) ? iscsi_globvec->first_burst_len : (uint32_t) atol( (char *) first_burst_len_val )); - - uint8_t *max_burst_len_val; - rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN, &max_burst_len_val ); - uint32_t max_burst_len = ((rc < 0) ? iscsi_globvec->max_burst_len : (uint32_t) atol( (char *) max_burst_len_val )); - - if ( first_burst_len > max_burst_len ) { - first_burst_len = max_burst_len; - - if ( first_burst_len_val != NULL ) { - sprintf( (char *) first_burst_len_val, "%" PRId32, first_burst_len ); - } - } - - pos += (uint32_t) (snprintf( (char *) (buf + pos), (len - pos), "%s=%" PRId32, key, first_burst_len ) + 1); - } + int32_t rc; + do { + rc = (int32_t) recv( conn->client->sock, buf, (size_t) len, MSG_WAITALL ); + } while ( rc == -1 && errno == EINTR ); - return pos; + if ( rc == 0 ) + return -1; // EOF + return rc; } /** @@ -9693,8 +2552,7 @@ static int32_t iscsi_append_special_key_value_pair_packet(iscsi_connection *conn * and value pair to an output DataSegment * buffer and truncates if necessary. * - * @param[in] key_value_pair Pointer to key and value pair containing - * its attributes. + * @param[in] number true = int, false = char* * @param[in] key Pointer to key to be written to output * buffer. NULL is NOT allowed, take caution. * @param[in] value Pointer to value of the key that should @@ -9705,529 +2563,25 @@ static int32_t iscsi_append_special_key_value_pair_packet(iscsi_connection *conn * prohibited, so be careful. * @param[in] pos Position of buffer in bytes to start * writing to. - * @param[in] len Total length of buffer in bytes. - * @return New buffer position in bytes or a negative - * error code. - */ -static int32_t iscsi_append_key_value_pair_packet(const iscsi_key_value_pair *key_value_pair, const uint8_t *key, const uint8_t *value, uint8_t *buf, uint32_t pos, const uint32_t len) -{ - if ( (key_value_pair == NULL) || ((key_value_pair->type != ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_DECLARATIVE) && (key_value_pair->type != ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_DECLARATIVE)) ) { - if ( pos >= len ) - return -1L; - - pos += (uint32_t) (snprintf( (char *) (buf + pos), (len - pos), "%s=%s", key, value ) + 1); - } - - return pos; -} - -/** - * @brief Negotiates key and value pair of list type. - * - * This function checks if a key of list type has a - * valid value according to the iSCSI specification. - * - * @param[in] key_value_pair Pointer to key and value pair. May NOT - * be NULL, so be careful. - * @param[in] old_value Pointer to string containing the old - * value. NULL is not allowed, so take caution. - * @return Pointer to original value, if the value is - * allowed or NULL otherwise. + * @param[in] buflen Total length of buffer in bytes. + * @return -1 if buffer is already full, otherwise the number + * of bytes that are written or would have been written to + * the buffer. */ -static uint8_t *iscsi_negotiate_key_value_pair_list(const iscsi_key_value_pair *key_value_pair, const uint8_t *old_value) +static int iscsi_append_key_value_pair_packet(const bool number, const char *key, const char *value, char *buf, const uint32_t pos, const uint32_t buflen) { - uint8_t *list = key_value_pair->list_range; - const uint8_t *value = (uint8_t *) strchr( (char *) old_value, ',' ); - size_t val_len = ((value != NULL) ? (size_t) (value - old_value) : strlen( (char *) old_value )); - - for ( ;; ) { - const size_t len = strlen( (char *) list ); - - if ( (val_len == len) && (strncasecmp( (char *) list, (char *) old_value, len ) == 0) ) - return list; - - list += (len + 1); - - if ( list[0] == '\0' ) { - if ( value == NULL ) - break; - - old_value = value; - list = key_value_pair->list_range; - value = (uint8_t *) strchr( (char *) ++old_value, ',' ); - val_len = ((value != NULL) ? (size_t) (value - old_value) : strlen( (char *) old_value )); - } - } - - return NULL; -} - -/** - * @brief Negotiates key and value pair of numeric type. - * - * This function checks if a key of numeric type has - * a valid interger value and clamps within the - * allowed minimum and maximum range according to - * the iSCSI specification. - * - * @param[in] key_value_pair Pointer to key and value pair. May NOT - * be NULL, so be careful. - * @param[in] old_value Pointer to string containing the old - * value. NULL is not allowed, take caution. - * @param[in] value Pointer to string containing the current - * value which may NOT be NULL, so be careful. - * @return Pointer to original value, if the value is - * allowed or NULL otherwise. - */ -static uint8_t *iscsi_negotiate_key_value_pair_num(const iscsi_key_value_pair *key_value_pair, uint8_t *old_value, uint8_t *value) -{ - int32_t old_int_val = (int32_t) atol( (char *) key_value_pair->value ); - - if ( (key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_USE_PREVIOUS_VALUE) != 0 ) - old_int_val = (int32_t) atol( (char *) old_value ); - - int32_t int_val = (int32_t) atol( (char *) value ); - - const uint8_t *range = key_value_pair->list_range; - const int32_t range_min = (int32_t) atol( (char *) range ); - const int32_t range_max = (int32_t) atol( (char *) (range + strlen( (char *) range ) + 1) ); - - if ( (old_int_val < range_min) || (old_int_val > range_max) ) - return NULL; - - switch ( key_value_pair->type ) { - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN : { - if ( old_int_val > int_val ) - old_int_val = int_val; - - break; - } - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MAX : { - if ( old_int_val < int_val ) - old_int_val = int_val; - - break; - } - default : { - return old_value; - - break; - } - } - - sprintf( (char *) old_value, "%" PRId32, old_int_val ); - - return old_value; -} - -/** - * @brief Negotiates key and value pair of boolean type. - * - * This function checks if a key of boolean type - * has a valid value according to the iSCSI - * specification and also applies the boolean - * OR / AND function to the current value. - * - * @param[in] key_value_pair Pointer to key and value pair. May NOT - * be NULL, so be careful. - * @param[in] old_value Pointer to string containing the old - * value. NULL is not allowed, so take caution. - * @param[in] value Pointer to string containing the - * current value which may NOT be NULL, so be - * careful. - * @param[in] bool_value Pointer to string containing the - * boolean OR / AND value where NULL is - * prohibited, so take caution. - * @param[out] update_key_value_pair Pointer to integer which - * marks if the key and value pair should be - * updated. May NOT be NULL, so be careful. - * @return Pointer to either boolean AND / OR result, - * default value or NULL in case of invalid - * boolean value. - */ -static uint8_t *iscsi_negotiate_key_value_pair_bool(const iscsi_key_value_pair *key_value_pair, uint8_t *old_value, uint8_t *value, uint8_t *bool_value, int *update_key_value_pair) -{ - const uint8_t *list_bool_true = key_value_pair->list_range; - const uint8_t *list_bool_false = list_bool_true + strlen( (char *) list_bool_true ) + 1UL; - - if ( (strcasecmp( (char *) old_value, (char *) list_bool_true ) != 0) && (strcasecmp( (char *) old_value, (char *) list_bool_false ) != 0) ) { - *update_key_value_pair = 0; - - return (uint8_t *) "Reject"; - } - - return ((strcasecmp( (char *) value, (char *) bool_value ) == 0) ? bool_value : old_value); -} - -/** - * @brief Negotiates key and value pair of all types. - * - * This function determines the key type and - * calls the suitable negotation handler - * for checking iSCSI standard compliance. - * - * @param[in] key_value_pair Pointer to key and value pair. May NOT - * be NULL, so be careful. - * @param[in] old_value Pointer to string containing the old - * value. NULL is not allowed, so take caution. - * @param[in] value Pointer to string containing the - * current value which may NOT be NULL, so be - * careful. - * @param[out] update_key_value_pair Pointer to integer which - * marks if the key and value pair should be - * updated. NULL is not allowed, take caution. - * @return Pointer to new negotiated value or NULL - * in case of an invalid negation status. - */ -static uint8_t *iscsi_negotiate_key_value_pair_all(const iscsi_key_value_pair *key_value_pair, uint8_t *old_value, uint8_t *value, int *update_key_value_pair) -{ - switch ( key_value_pair->type ) { - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_LIST : { - return iscsi_negotiate_key_value_pair_list( key_value_pair, old_value ); - - break; - } - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MIN : - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_MAX : - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_NUM_DECLARATIVE : { - return iscsi_negotiate_key_value_pair_num( key_value_pair, old_value, value ); - - break; - } - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_AND : { - return iscsi_negotiate_key_value_pair_bool( key_value_pair, old_value, value, key_value_pair->list_range, update_key_value_pair ); - - break; - } - case ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_BOOL_OR : { - uint8_t *list_bool_true = key_value_pair->list_range; - uint8_t *list_bool_false = list_bool_true + strlen( (char *) list_bool_true ) + 1UL; - - return iscsi_negotiate_key_value_pair_bool( key_value_pair, old_value, value, list_bool_false, update_key_value_pair ); - - break; - } - default : { - break; - } - } - - return key_value_pair->value; -} - -/** - * @brief Negotiates either iSCSI session or connection state. - * - * This function checks and sets the state mask - * of either an iSCSI connection or session - * key and value pair. - * - * @param[in] conn Pointer to iSCSI connection of which to - * determine the key type. NULL is NOT allowed, - * so be careful. - * @param[in] key_value_pair Pointer to key and value pair - * containing the key and value pair attributes. - * NULL is NOT allowed, so be careful. - * @param[in] type Type of key and value pair to negotiate. - * 0 is iSCSI connection key and value pair, - * any other value indicates an iSCSI session - * key and value pair. - * @return 0 on successful state negotation, a - * negative error code otherwise. - */ -static int iscsi_negotiate_key_value_pairs_state(iscsi_connection *conn, const iscsi_key_value_pair *key_value_pair, const int type) -{ - if ( type != 0 ) { - const uint32_t state_mask = (uint32_t) key_value_pair->state_mask; - - if ( ((conn->session_state_negotiated & state_mask) != 0) && ((key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_TARGET_DECLARATIVE) == 0) ) - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER_XCHG_NOT_ONCE; - - conn->session_state_negotiated |= state_mask; - } else { - const uint16_t state_mask = (uint16_t) key_value_pair->state_mask; - - if ( ((conn->state_negotiated & state_mask) != 0) && ((key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_MULTI_NEGOTIATION) == 0) ) - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER_XCHG_NOT_ONCE; - - conn->state_negotiated |= state_mask; - } - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Callback which negotiates a single key and value pairs required for session authentication. - * - * This function is called for each key and value - * pair which needs connection or session - * authentication. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data Pointer to integer value which is - * 1 is this is discovery, or 0 if not. - * @return Always returns 0 as this function cannot fail. - */ -int iscsi_negotiate_key_value_pair_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data) -{ - iscsi_key_value_pair_packet *key_value_pair_packet = (iscsi_key_value_pair_packet *) user_data; - iscsi_connection *conn = key_value_pair_packet->conn; - iscsi_hashmap *key_value_pairs = conn->key_value_pairs; - iscsi_key_value_pair *key_value_pair = NULL; - int type = 0; - int rc = iscsi_hashmap_get( iscsi_globvec->connection_key_value_pairs, key, key_size, (uint8_t **) &key_value_pair); - - if ( rc < 0 ) { - key_value_pairs = conn->session->key_value_pairs; - type = 1; - - rc = iscsi_hashmap_get( iscsi_globvec->session_key_value_pairs, key, key_size, (uint8_t **) &key_value_pair); - } - - if ( (rc == 0) && (key_value_pair->flags & (ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_CHAP_TYPE | ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_SPECIAL_HANDLING)) != 0 ) - return 0; - - int update_key_value_pair = 1; - uint8_t *conn_sess_val; - - if ( rc < 0 ) { - conn_sess_val = (uint8_t *) "NotUnderstood"; - - update_key_value_pair = 0; - } else if ( (key_value_pair_packet->discovery != 0) && ((key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_DISCOVERY_IGNORE) != 0) ) { - conn_sess_val = (uint8_t *) "Irrelevant"; - - update_key_value_pair = 0; - } else { - rc = iscsi_negotiate_key_value_pairs_state( conn, key_value_pair, type ); - - if ( rc < 0 ) - return rc; - - rc = iscsi_hashmap_get( key_value_pairs, key, key_size, &conn_sess_val ); - } - - if ( (key_value_pair != NULL) && (key_value_pair->type > ISCSI_TEXT_KEY_VALUE_PAIR_TYPE_UNSPECIFIED) ) { - if ( (key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_USE_PREVIOUS_VALUE) != 0 ) { - uint8_t *max_burst_len_val; - uint32_t first_burst_len = (uint32_t) atol( (char *) value ); - uint32_t max_burst_len; - - rc = iscsi_get_key_value_pair( key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN, &max_burst_len_val ); - - max_burst_len = ((rc < 0) ? iscsi_globvec->max_burst_len : (uint32_t) atol( (char *) max_burst_len_val )); - - if ( (first_burst_len < ISCSI_MAX_DS_SIZE) && (first_burst_len > max_burst_len) ) - sprintf( (char *) value, "%" PRId32, first_burst_len ); - } - - if ( (key_value_pair->flags & ISCSI_TEXT_KEY_VALUE_PAIR_FLAGS_TARGET_DECLARATIVE) != 0 ) - update_key_value_pair = 0; - - conn_sess_val = iscsi_negotiate_key_value_pair_all( key_value_pair, value, conn_sess_val, &update_key_value_pair ); - } - - if ( conn_sess_val != NULL ) { - if ( update_key_value_pair != 0 ) - iscsi_update_key_value_pair( key_value_pairs, key, conn_sess_val ); - - key_value_pair_packet->pos = iscsi_append_key_value_pair_packet( key_value_pair, key, conn_sess_val, key_value_pair_packet->buf, key_value_pair_packet->pos, key_value_pair_packet->len ); - - if ( (int32_t) key_value_pair_packet->pos < 0L ) - return key_value_pair_packet->pos; - - key_value_pair_packet->pos = iscsi_append_special_key_value_pair_packet( conn, key_value_pair, key, key_value_pair_packet->buf, key_value_pair_packet->pos, key_value_pair_packet->len ); + if ( pos >= buflen ) + return -1; - if ( (int32_t) key_value_pair_packet->pos < 0L ) - return key_value_pair_packet->pos; + const ssize_t maxlen = buflen - pos; + if ( number ) { + return (int)snprintf( (buf + pos), maxlen, "%s=%d", key, (const int)(const size_t)value ) + 1; } - - return 0; + return (int)snprintf( (buf + pos), maxlen, "%s=%s", key, value ) + 1; } -/** - * @brief Negotiates all key and value pairs required for session authentication. - * - * @param[in] conn Pointer to iSCSI connection to be - * negotiated, may NOT be NULL, so be careful. - * @param[in] key_value_pairs Pointer to key and value pair hash map - * which contains the negotiation pairs. NULL - * is prohibited, so take caution. - * @param[in] buf Pointer to output buffer which may NOT - * be NULL, so be careful. - * @param[in] pos Number of bytes already written. - * @param[in] len Length of DataSegment in bytes. - * @return New buffer length in bytes if all keys - * could be negotiated, a negative error - * code otherwise. - */ -int32_t iscsi_negotiate_key_value_pairs(iscsi_connection *conn, iscsi_hashmap *key_value_pairs, uint8_t *buf, const uint32_t pos, const uint32_t len) -{ - if ( pos > len ) { - buf[len - 1UL] = '\0'; - - return len; - } - - uint8_t *type; - int rc = iscsi_get_key_value_pair( key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_SESSION_TYPE, &type ); - - if ( rc < 0 ) - rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_SESSION_TYPE, &type ); - - const int discovery = (((rc == 0) && (strcasecmp( (char *) type, "Discovery" ) == 0)) ? 1 : 0); - iscsi_key_value_pair_packet key_value_pair_packet = {conn, buf, pos, len, discovery}; - iscsi_hashmap_iterate( key_value_pairs, iscsi_negotiate_key_value_pair_callback, (uint8_t *) &key_value_pair_packet ); - - return key_value_pair_packet.pos; -} - -/** - * @brief Copies retrieved key and value pairs into SCSI connection and session structures. - * - * This function converts string representations of - * integer and boolean key and value pairs. - * - * @param[in] conn Pointer to iSCSI connection which holds the - * copies of the key and value pairs. - * @retval -1 An error occured during the copy process, - * e.g. memory is exhausted. - * @retval 0 All key and value pairs were copied successfully. - */ -int iscsi_connection_copy_key_value_pairs(iscsi_connection *conn) -{ - int32_t int_val; - - int rc = iscsi_get_int_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_RECV_DS_LEN, &int_val); - - if ( rc != 0 ) - return rc; - - if ( (int_val <= 0L) || (int_val > (int32_t) ISCSI_DEFAULT_MAX_RECV_DS_LEN) ) - int_val = ISCSI_DEFAULT_MAX_RECV_DS_LEN; - - conn->max_recv_ds_len = int_val; - - uint8_t *value; - - rc = iscsi_get_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_HEADER_DIGEST, &value); - - if ( rc != 0 ) - return rc; - - conn->header_digest = ((strcasecmp( (char *) value, "CRC32C" ) == 0) ? ISCSI_DIGEST_SIZE : 0); - - rc = iscsi_get_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_DIGEST, &value); - - if ( rc != 0 ) - return rc; - - conn->data_digest = ((strcasecmp( (char *) value, "CRC32C" ) == 0) ? ISCSI_DIGEST_SIZE : 0); - - rc = iscsi_get_int_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_CONNECTIONS, &int_val); - - if ( rc != 0 ) - return rc; - - conn->session->max_conns = int_val; - - rc = iscsi_get_int_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_OUTSTANDING_R2T, &int_val); - - if ( rc != 0 ) - return rc; - - conn->session->max_outstanding_r2t = int_val; - - rc = iscsi_get_int_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_FIRST_BURST_LEN, &int_val); - - if ( rc != 0 ) - return rc; - - conn->session->first_burst_len = int_val; - - rc = iscsi_get_int_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN, &int_val); - - if ( rc != 0 ) - return rc; - - conn->session->max_burst_len = int_val; - - rc = iscsi_get_bool_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_INITIAL_R2T, &int_val); - - if ( rc != 0 ) - return rc; - - conn->session->flags &= ~(ISCSI_SESSION_FLAGS_INIT_R2T | ISCSI_SESSION_FLAGS_IMMEDIATE_DATA); - - if ( int_val != 0L ) - conn->session->flags |= ISCSI_SESSION_FLAGS_INIT_R2T; - - rc = iscsi_get_bool_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IMMEDIATE_DATA, &int_val); - - if ( rc != 0 ) - return rc; - - if ( int_val != 0L ) - conn->session->flags |= ISCSI_SESSION_FLAGS_IMMEDIATE_DATA; - - return 0; -} - -/** - * @brief Handles stages of CHAP and other authentication methods. - * - * This function handles the various stages of the - * various authentication methods supported by the - * iSCSI protocol.\n - * Currently, only CHAP is implemented. - * - * @param[in] conn Pointer to iSCSI connection which may NOT - * be NULL, so be careful. - * @param[in] key_value_pairs Pointer to hash map containing the - * authentication key and value pairs. NULL - * is NOT allowed here, so take caution. - * @param[in] auth_method Pointer to string containing the - * authentication method. NULL is forbidden, - * so be careful. - * @param[in] buf Pointer to DataSegment buffer. May NOT be - * NULL, so take caution. - * @param[in] pos Remaining number of bytes to read. - * @param[in] len Total number of bytes of DataSegment buffer. - * @return 0 if authentication methods were handled successfully, - * a negative error code otherwise. - */ -static int32_t iscsi_connection_auth_key_value_pairs(iscsi_connection *conn, iscsi_hashmap *key_value_pairs, const uint8_t *auth_method, uint8_t *buf, const uint pos, const uint len) -{ - // TODO: Implement CHAP and other authentication methods. - - return 0; -} - -/** - * @brief Checks buffer sizes of an iSCSI connection with it's associated session for consistency. - * - * This function ensures that, for example, first - * burst length does not exceed maximum burst - * length and that the buffers don't exceed their - * minimum and maximum allowed values. - * - * @param[in] conn Pointer to iSCSI connection which holds the - * values to be checked for consistency. May NOT be NULL, - * so take caution. - * @retval -1 At least one value check failed the consistency check. - * @retval 0 All consistency checks have passed successfully. - */ -static int iscsi_connection_check_key_value_pairs(iscsi_connection *conn) -{ - if ( (conn->session->first_burst_len > conn->session->max_burst_len) || (conn->session->first_burst_len < 512UL) || (conn->session->max_burst_len < 512UL) || (conn->session->max_burst_len > iscsi_globvec->max_burst_len) || (conn->max_recv_ds_len < 512UL) || (conn->max_recv_ds_len > iscsi_globvec->max_burst_len) ) - return -1; - - return 0; -} +#define CLAMP(val, min, max) ((val) < (min) ? (min) : ((val) > (max) ? (max) : (val))) /** * @brief Updates iSCSI connection and session values after being retrieved from the client. @@ -10238,7 +2592,7 @@ static int iscsi_connection_check_key_value_pairs(iscsi_connection *conn) * The TCP receive buffer will be adjusted to the new * updated value but is never lower than 4KiB and never * higher than 8KiB plus header overhead and a factor of - * 4 for receiving four packets at once. + * 16 for receiving 16 packets at once. * * @param[in] conn Pointer to ISCSI connection which should * be updated. @@ -10246,38 +2600,11 @@ static int iscsi_connection_check_key_value_pairs(iscsi_connection *conn) * @retval 0 All values have been updated successfully and * the socket is still alive. */ -static int iscsi_connection_update_key_value_pairs(iscsi_connection *conn) +static void iscsi_connection_update_key_value_pairs(iscsi_connection *conn, iscsi_negotiation_kvp *pairs) { - int rc = iscsi_connection_copy_key_value_pairs( conn ); - - if ( rc < 0 ) { - if ( conn->state < ISCSI_CONNECT_STATE_EXITING ) - conn->state = ISCSI_CONNECT_STATE_EXITING; - - return rc; - } - - rc = iscsi_connection_check_key_value_pairs( conn ); - - if ( (rc < 0) && (conn->state < ISCSI_CONNECT_STATE_EXITING) ) - conn->state = ISCSI_CONNECT_STATE_EXITING; - - if ( conn->sock < 0 ) - return -1; - - uint recv_buf_len = conn->session->first_burst_len; - - if ( recv_buf_len < 4096U ) - recv_buf_len = 4096U; - else if ( recv_buf_len > 8192U ) - recv_buf_len = 8192U; - - recv_buf_len += (uint) (sizeof(struct iscsi_bhs_packet) + ISCSI_MAX_AHS_SIZE + conn->header_digest + conn->data_digest); // BHS + maximum AHS size + header and data digest overhead - recv_buf_len <<= 2U; // Receive up to four streams at once. - - setsockopt( conn->sock, SOL_SOCKET, SO_RCVBUF, &recv_buf_len, sizeof(recv_buf_len)); // Not being able to set the buffer is NOT fatal, so ignore error. - - return rc; + conn->session->opts.MaxBurstLength = CLAMP(pairs->MaxBurstLength, 512, ISCSI_MAX_DS_SIZE); + conn->session->opts.FirstBurstLength = CLAMP(pairs->FirstBurstLength, 512, pairs->MaxBurstLength); + conn->session->opts.MaxRecvDataSegmentLength = CLAMP(pairs->MaxRecvDataSegmentLength, 512, ISCSI_MAX_DS_SIZE); } /** @@ -10289,94 +2616,40 @@ static int iscsi_connection_update_key_value_pairs(iscsi_connection *conn) * @param[in] conn Pointer to ISCSI connection to send the TCP/IP * packet with. May NOT be NULL, so be * careful. - * @param[in] login_response_pdu Pointer to login response PDU to + * @param[in] resp_pdu Pointer to login response PDU to * be sent via TCP/IP. NULL is NOT * allowed here, take caution. - * @param[in] key_value_pairs Pointer to hash map of key and value pairs - * to be used for login response storage. - * @param[in] callback Pointer to post processing callback function - * after sending the TCP/IP packet. * @return 0 if the login response has been sent * successfully, a negative error code otherwise. */ -static int iscsi_connection_pdu_login_response(iscsi_connection *conn, iscsi_pdu *login_response_pdu, iscsi_hashmap *key_value_pairs, iscsi_connection_xfer_complete_callback callback) +static int iscsi_connection_pdu_login_response(iscsi_connection *conn, iscsi_pdu *resp_pdu) { - const uint32_t ds_len = login_response_pdu->ds_len; - - login_response_pdu->ds_len = login_response_pdu->len; - - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) iscsi_connection_pdu_append( login_response_pdu, login_response_pdu->ahs_len, 0, ds_len, 0 ); + iscsi_login_response_packet *login_response_pkt = + (iscsi_login_response_packet *) iscsi_connection_pdu_resize( resp_pdu, resp_pdu->ahs_len, resp_pdu->ds_write_pos ); login_response_pkt->version_max = ISCSI_VERSION_MAX; login_response_pkt->version_active = ISCSI_VERSION_MAX; - iscsi_put_be32( (uint8_t *) &login_response_pkt->total_ahs_len, ds_len ); // TotalAHSLength is always 0 and DataSegmentLength is 24-bit, so write in one step. + iscsi_put_be32( (uint8_t *) &login_response_pkt->total_ahs_len, resp_pdu->ds_len ); // TotalAHSLength is always 0 and DataSegmentLength is 24-bit, so write in one step. iscsi_put_be32( (uint8_t *) &login_response_pkt->stat_sn, conn->stat_sn++ ); - if ( conn->session != NULL ) { + if ( conn->session != NULL ) { // TODO: Needed? MC/S? iscsi_put_be32( (uint8_t *) &login_response_pkt->exp_cmd_sn, conn->session->exp_cmd_sn ); iscsi_put_be32( (uint8_t *) &login_response_pkt->max_cmd_sn, conn->session->max_cmd_sn ); } else { - iscsi_put_be32( (uint8_t *) &login_response_pkt->exp_cmd_sn, login_response_pdu->cmd_sn ); - iscsi_put_be32( (uint8_t *) &login_response_pkt->max_cmd_sn, login_response_pdu->cmd_sn ); + iscsi_put_be32( (uint8_t *) &login_response_pkt->exp_cmd_sn, resp_pdu->cmd_sn ); + iscsi_put_be32( (uint8_t *) &login_response_pkt->max_cmd_sn, resp_pdu->cmd_sn ); } if ( login_response_pkt->status_class != ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SUCCESS ) login_response_pkt->flags &= (int8_t) ~(ISCSI_LOGIN_RESPONSE_FLAGS_TRANSIT | ISCSI_LOGIN_RESPONSE_FLAGS_CURRENT_STAGE_MASK | ISCSI_LOGIN_RESPONSE_FLAGS_NEXT_STAGE_MASK ); - iscsi_connection_pdu_write( conn, login_response_pdu, callback, (uint8_t *) conn ); - - if ( key_value_pairs != NULL ) { - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); - } + iscsi_connection_pdu_write( conn, resp_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } /** - * @brief Callback function after login response has been sent. - * - * This function is invoked after the login - * response has been sent to the client via - * TCP/IP. - * - * @param[in] user_data Pointer to iSCSI connection which - * was used for sending the response. - */ -static void iscsi_connection_pdu_login_err_complete(uint8_t *user_data) -{ - iscsi_connection *conn = (iscsi_connection *) user_data; - - if ( (conn->flags & ISCSI_CONNECT_FLAGS_FULL_FEATURE) != 0 ) - iscsi_connection_update_key_value_pairs( conn ); -} - -/** - * @brief Callback function after login response has been sent. - * - * This function is invoked after the login - * response has been sent to the client via - * TCP/IP. - * - * @param[in] user_data Pointer to iSCSI connection which - * was used for sending the response. - */ -static void iscsi_connection_pdu_login_ok_complete(uint8_t *user_data) -{ - iscsi_connection *conn = (iscsi_connection *) user_data; - - if ( conn->state >= ISCSI_CONNECT_STATE_EXITING ) - return; - - if ( (conn->flags & ISCSI_CONNECT_FLAGS_FULL_FEATURE) != 0 ) { - iscsi_connection_update_key_value_pairs( conn ); - - iscsi_connection_schedule( conn ); - } -} - -/** * @brief Initializes an iSCSI login response PDU structure. * * This function initializes the internal login @@ -10395,18 +2668,13 @@ static int iscsi_connection_pdu_login_response_init(iscsi_pdu *login_response_pd iscsi_login_req_packet *login_req_pkt = (iscsi_login_req_packet *) pdu->bhs_pkt; iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - login_response_pdu->ds_len = 0UL; - login_response_pkt->opcode = ISCSI_OPCODE_SERVER_LOGIN_RES; login_response_pkt->flags = (int8_t) (login_req_pkt->flags & (ISCSI_LOGIN_REQ_FLAGS_TRANSIT | ISCSI_LOGIN_REQ_FLAGS_CONTINUE | ISCSI_LOGIN_REQ_FLAGS_CURRENT_STAGE_MASK)); if ( (login_response_pkt->flags & ISCSI_LOGIN_RESPONSE_FLAGS_TRANSIT) != 0 ) login_response_pkt->flags |= (login_req_pkt->flags & ISCSI_LOGIN_REQ_FLAGS_NEXT_STAGE_MASK); - login_response_pkt->isid.a = login_req_pkt->isid.a; - login_response_pkt->isid.b = login_req_pkt->isid.b; // Copying over doesn't change endianess. - login_response_pkt->isid.c = login_req_pkt->isid.c; - login_response_pkt->isid.d = login_req_pkt->isid.d; // Copying over doesn't change endianess. + login_response_pkt->isid = login_req_pkt->isid; login_response_pkt->tsih = login_req_pkt->tsih; // Copying over doesn't change endianess.' login_response_pkt->init_task_tag = login_req_pkt->init_task_tag; // Copying over doesn't change endianess. login_response_pkt->reserved = 0UL; @@ -10445,118 +2713,6 @@ static int iscsi_connection_pdu_login_response_init(iscsi_pdu *login_response_pd } /** - * @brief Saves incoming key / value pairs from the client of a login request PDU. - * - * The login response structure has status detail - * invalid login request type set in case of an error. - * - * @param[in] conn Pointer to iSCSI connection - * used for key and value pair extraction. - * @param[out] key_value_pairs Pointer to hash map which - * stores all the parsed key and value pairs. - * @param[in] login_response_pdu Pointer to iSCSI login response - * PDU, may NOT be NULL, so be careful. - * @param[in] pdu Pointer to iSCSI login request packet - * PDU, may NOT be NULL, so be careful. - * @retval -1 An error occured during parse of - * key and value pairs (memory exhaustion). - * @retval 0 All key and value pairs have been parsed successfully. - */ -int iscsi_connection_save_incoming_key_value_pairs(iscsi_connection *conn, iscsi_hashmap *key_value_pairs, iscsi_pdu *login_response_pdu, const iscsi_pdu *pdu) -{ - iscsi_login_req_packet *login_req_pkt = (iscsi_login_req_packet *) pdu->bhs_pkt; - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - const int rc = iscsi_parse_key_value_pairs( key_value_pairs, (uint8_t *) pdu->ds_cmd_data, pdu->ds_len, ((login_req_pkt->flags & ISCSI_LOGIN_REQ_FLAGS_CONTINUE) != 0), &conn->partial_pairs ); - - if ( rc < 0 ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISC; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER; - } - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Extracts the Initiator Session ID (ISID) from packet data into a 64-bit unsigned integer. - * - * The ISID is constructed by OR'ing and shifting the - * four parts a, b, c and d into their proper places - * with d being in the LSB area.\n - * Since the ISID is only 48 bit wide, the 16 - * MSB bits are always cleared. - * - * @param[in] isid Pointer to the ISID part of packet data. - * May NOT be NULL, so be careful. - * @return The 64-bit unsigned integer value representing - * the Initiator Session ID (ISID). - */ -static inline uint64_t iscsi_connection_get_isid(const iscsi_isid *isid) -{ - return ((uint64_t) isid->a << 40ULL) | ((uint64_t) iscsi_get_be16(isid->b) << 24ULL) | ((uint64_t) isid->c << 16ULL) | (uint64_t) iscsi_get_be16(isid->d); -} - -/** - * @brief Initializes the login response port names. - * - * This function extracts the initiator name from the - * key and value pair and stores the result in - * the iSCSI connection, as well as a full qualified - * initiator port name. - * - * @param[in] conn Pointer to iSCSI connection where to - * store the initiator name. - * @param[in] response_pdu Pointer to response PDU to initialize the - * port from, NULL is NOT allowed here, so be careful. - * @param[in] key_value_pairs Pointer to the hash map containing the key - * and value pair for the initiator name. May NOT be - * NULL, so take caution. - * @param[out] init_port_name Pointer to store the full qualified name - * of the initiator port and may NOT be NULL, so be careful. - * @return 0 in case the port could be initialized - * successfully, a negative error code otherwise - * in which case the status class and detail are - * set as well. - */ -static int iscsi_connection_login_init_port(iscsi_connection *conn, iscsi_pdu *response_pdu, iscsi_hashmap *key_value_pairs, uint8_t **init_port_name) -{ - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) response_pdu->bhs_pkt; - uint8_t *init_name; - int rc = iscsi_get_key_value_pair( key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_INITIATOR_NAME, &init_name ); - - if ( rc != 0 ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISSING_PARAMETER; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - - conn->init_name = iscsi_sprintf_alloc( "%s", init_name ); - - if ( conn->init_name == NULL ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - *init_port_name = iscsi_sprintf_alloc( "%s,i,0x%12.12" PRIx64, init_name, iscsi_connection_get_isid( &login_response_pkt->isid ) ); - - if ( *init_port_name == NULL ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; - - free( conn->init_name ); - conn->init_name = NULL; - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** * @brief Determines the session type of login. * * This function is used to retrieve the @@ -10566,47 +2722,28 @@ static int iscsi_connection_login_init_port(iscsi_connection *conn, iscsi_pdu *r * * @param[in] login_response_pdu Pointer to login response PDU, * NULL is not allowed, so take caution. - * @param[in] key_value_pairs Pointer to key and value pairs which + * @param[in] type_str Pointer to key and value pairs which * contain the session type parameter to be evaluated, * which may NOT be NULL, so take caution. - * @param[out] type Pointer to integer which stores the - * determined session type and is NOT allowed to be - * NULL, so be careful. * @return 0 on successful operation, a negative error code * otherwise. The output session 'type' is unchanged, if * an invalid session type value was retrieved. */ -static int iscsi_connection_login_session_type(iscsi_pdu *login_response_pdu, iscsi_hashmap *key_value_pairs, int *type ) +static int iscsi_login_parse_session_type(iscsi_pdu *login_response_pdu, const char *type_str, int *type) { iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - uint8_t *type_str; - int rc = iscsi_get_key_value_pair( key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_SESSION_TYPE, &type_str ); - - if ( (rc == 0) && (type_str != NULL) ) { - if ( strcasecmp( (char *) type_str, "Discovery" ) == 0 ) { - *type = ISCSI_SESSION_TYPE_DISCOVERY; - } else if ( strcasecmp( (char *) type_str, "Normal" ) == 0 ) { - *type = ISCSI_SESSION_TYPE_NORMAL; - } else { - *type = ISCSI_SESSION_TYPE_INVALID; - - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISSING_PARAMETER; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - } else { - if ( login_response_pkt->tsih != 0U ) { - *type = ISCSI_SESSION_TYPE_NORMAL; - } else { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISSING_PARAMETER; - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } + if ( type_str != NULL && strcasecmp( type_str, "Normal" ) == 0 ) { + *type = ISCSI_SESSION_TYPE_NORMAL; + return ISCSI_CONNECT_PDU_READ_OK; } - return ISCSI_CONNECT_PDU_READ_OK; + *type = ISCSI_SESSION_TYPE_INVALID; + logadd( LOG_DEBUG1, "Unsupported session type: %s", type_str ); + login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; + login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISSING_PARAMETER; + + return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; } /** @@ -10626,169 +2763,76 @@ static int iscsi_connection_login_session_type(iscsi_pdu *login_response_pdu, is * here, so take caution. * @param[in] target_name Pointer to target node name and may * NOT be NULL, be careful. - * @param[out] Pointer where to store the target node belonging - * to the target name. May NOT be NULL, so take caution. * @return 0 if the check was successful or a negative * error code otherwise. */ -static int iscsi_connection_login_check_target(iscsi_connection *conn, iscsi_pdu *login_response_pdu, uint8_t *target_name, iscsi_target_node **target) +static int iscsi_image_from_target(iscsi_connection *conn, iscsi_pdu *login_response_pdu, const char *target_name) { iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - *target = iscsi_target_node_find( target_name ); + char *image_rev = NULL; + char *tmpbuf = strdup( target_name ); + char *image_name = tmpbuf; + char *tmp = strchr( tmpbuf, ':' ); - if ( *target == NULL ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_NOT_FOUND; + if ( tmpbuf == NULL ) { + logadd( LOG_ERROR, "iscsi_target_node_image_get: Out of memory while allocating DNBD3 image name for iSCSI target node" ); + login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; + login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; } - if ( ((*target)->flags & ISCSI_TARGET_NODE_FLAGS_DESTROYED) != 0 ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_TARGET_REMOVED; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; + while ( tmp != NULL ) { + *tmp++ = '\0'; + if ( image_rev != NULL ) { + image_name = image_rev; + } + image_rev = tmp; + tmp = strchr( tmp, ':' ); } - uint8_t *redirect_adr = iscsi_target_node_get_redirect( conn, *target ); - - if ( redirect_adr != NULL ) { - iscsi_key_value_pair *key_value_pair; - const int rc = iscsi_hashmap_get( iscsi_globvec->session_key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS, strlen( (char *) ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS ) + 1, (uint8_t **) &key_value_pair); - - if ( rc < 0 ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; + uint16_t rev = 0; + if ( image_rev != NULL ) { + char *end = NULL; + long rid = strtol( image_rev, &end, 10 ); + if ( end == NULL || *end != '\0' || rid < 0 || rid > 0xFFFF ) { + logadd( LOG_DEBUG1, "iscsi_image_from_target: Invalid revision number (%s) in iSCSI target node name: '%s'", image_rev, target_name ); + } else { + rev = (uint16_t)rid; } + } + dnbd3_image_t *image = image_getOrLoad( image_name, rev ); - const int32_t ds_len = iscsi_append_key_value_pair_packet( key_value_pair, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS, redirect_adr, (uint8_t *) login_response_pdu->ds_cmd_data, login_response_pdu->ds_len, login_response_pdu->len ); - - if ( ds_len < 0L ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; + if ( image == NULL && image_rev != NULL ) { + image = image_getOrLoad( image_rev, rev ); + } - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } + if ( image == NULL && strncasecmp( image_name, ISCSI_TARGET_NODE_WWN_NAME_PREFIX, ISCSI_STRLEN(ISCSI_TARGET_NODE_WWN_NAME_PREFIX) ) == 0 ) { + uint64_t wwn = strtoull( (image_name + ISCSI_STRLEN(ISCSI_TARGET_NODE_WWN_NAME_PREFIX)), NULL, 16 ); - login_response_pdu->ds_len = ds_len; - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_REDIRECT; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_REDIRECT_TEMP; + image = image_getByWwn( wwn, rev, true ); - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; + if ( image == NULL ) { + wwn = strtoull( (tmp + ISCSI_STRLEN(ISCSI_TARGET_NODE_WWN_NAME_PREFIX)), NULL, 16 ); + image = image_getByWwn( wwn, rev, true ); + } } - if ( iscsi_target_node_access( conn, *target, conn->init_name, conn->init_adr ) < 0 ) { + free( tmpbuf ); + + if ( image == NULL ) { login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_AUTH_FAIL; + login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_NOT_FOUND; return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; } + conn->client->image = image; return ISCSI_CONNECT_PDU_READ_OK; } /** - * @brief Retrieves iSCSI session by Target Session Identifying Handle (TSIH). - * - * This function checks if the TSIH is valid and if so, - * retrieves the pointer to its iSCSI session structure. - * - * @param[in] tsih Target Session Identifying Handle (TSIH). - * @return Pointer to related iSCSI session or NULL in case - * the TSIH is invalid or not found. - */ -static iscsi_session *iscsi_session_get_by_tsih(const uint16_t tsih) -{ - if ( tsih == 0U ) - return NULL; - - const uint64_t hash_key = tsih; - iscsi_session *session; - - pthread_rwlock_rdlock( &iscsi_globvec->sessions_rwlock ); - - int rc = iscsi_hashmap_get( iscsi_globvec->sessions, (uint8_t *) &hash_key, sizeof(hash_key), (uint8_t **) &session ); - - pthread_rwlock_unlock( &iscsi_globvec->sessions_rwlock ); - - return ((rc == 0) ? session : NULL); -} - -/** - * @brief Appends an iSCSI connection to a session. - * - * This function checks if the maximum number of - * connections per session is not exceeded and if - * there is session spanning. - * @param[in] conn Pointer to iSCSI connection, may NOT - * be NULL, so be careful. - * @param[in] init_port_name Pointer to initiator port name, - * may NOT be NULL, so take caution. - * @param[in] tsih Target Session Identifying Handle (TSIH). - * @return Upper 8 bits of contain status class, lower 8 - * bits status detail. All 16 bits set to zero - * indicate success. - */ -static uint16_t iscsi_session_append(iscsi_connection *conn, const uint8_t *init_port_name, const uint16_t tsih) -{ - iscsi_session *session = iscsi_session_get_by_tsih( tsih ); - - if ( (session == NULL) || (conn->pg_tag != session->tag) || (strcasecmp( (char *) init_port_name, (char *) iscsi_port_get_name( session->init_port ) ) != 0) || (conn->target != session->target) ) - return (ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR << 8U) | ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_NO_SESSION_SPANNING; - - if ( session->conns >= session->max_conns ) - return (ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR << 8U) | ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_TOO_MANY_CONNECTIONS; - - conn->session = session; - - iscsi_list_enqueue( &session->conn_list, &conn->node ); - - session->conns++; - - return (ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SUCCESS << 8U) | ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SUCCESS; -} - -/** - * @brief Checks whether the session is valid. - * - * This function also appends the connection - * to a session if it's valid.' - * - * @param[in] conn Pointer to iSCSI connection, - * may NOT be NULL, so take caution. - * @param[in] login_response_pdu Pointer to login response PDU, - * NULL is not allowed, hence be careful. - * @param[in] init_port_name Pointer to initiator port name. - * Non-NULL only, so be careful. - * @param[in] cid Connection ID (CID). - * @return 0 if valid session, a negative error code - * otherwise. - */ -static int iscsi_connection_login_check_session(iscsi_connection *conn, iscsi_pdu *login_response_pdu, uint8_t *init_port_name, uint cid) -{ - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - int rc = 0; - - if ( login_response_pkt->tsih != 0U ) { - rc = iscsi_session_append( conn, init_port_name, iscsi_get_be16(login_response_pkt->tsih) ); - - if ( rc != 0 ) { - login_response_pkt->status_class = (uint8_t) (rc >> 8U); - login_response_pkt->status_detail = (uint8_t) rc; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - } else if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_ISID_ALLOW_DUPLICATES) != 0 ) { - iscsi_connection_drop( conn, init_port_name, 0 ); - } - - return rc; -} - -/** * @brief Initializes a rejecting login response packet. * * The login response structure has status detail @@ -10799,7 +2843,7 @@ static int iscsi_connection_login_check_session(iscsi_connection *conn, iscsi_pd * @param[in] pdu Pointer to iSCSI login request PDU, may NOT * be NULL, so be careful. */ -void iscsi_connection_login_response_reject(iscsi_pdu *login_response_pdu, const iscsi_pdu *pdu) +static void iscsi_connection_login_response_reject(iscsi_pdu *login_response_pdu, const iscsi_pdu *pdu) { iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; @@ -10808,10 +2852,6 @@ void iscsi_connection_login_response_reject(iscsi_pdu *login_response_pdu, const login_response_pkt->version_max = ISCSI_VERSION_MAX; login_response_pkt->version_active = ISCSI_VERSION_MAX; *(uint32_t *) &login_response_pkt->total_ahs_len = 0UL; // TotalAHSLength and DataSegmentLength are always 0, so write in one step. - login_response_pkt->isid.a = 0U; - login_response_pkt->isid.b = 0U; - login_response_pkt->isid.c = 0U; - login_response_pkt->isid.d = 0U; login_response_pkt->tsih = 0U; login_response_pkt->init_task_tag = ((iscsi_login_req_packet *) pdu->bhs_pkt)->init_task_tag; login_response_pkt->reserved = 0UL; @@ -10834,70 +2874,51 @@ void iscsi_connection_login_response_reject(iscsi_pdu *login_response_pdu, const * @param[in] conn Pointer to connection to link the PDU with. * If this is NULL the connection has to be * linked later. - * @param[in] ahs_len Length of AHS packet data to be appended. - * @param[in] header_digest_size Length of header digest. Currently, - * only 0, in which case the header digest will - * be removed, or 4 for CRC32C are allowed. * @param[in] ds_len Length of DataSegment packet data to be appended. * May not exceed 16MiB - 1 (16777215 bytes). - * @param[in] data_digest_size Length of optional data digest (0 or - * 4 for now) to add. * @return Pointer to allocated and zero filled PDU or NULL * in case of an error (usually memory exhaustion). */ -iscsi_pdu *iscsi_connection_pdu_create(iscsi_connection *conn, const uint ahs_len, const int header_digest_size, const uint32_t ds_len, const int data_digest_size) +static iscsi_pdu *iscsi_connection_pdu_create(iscsi_connection *conn, const uint32_t ds_len) { - if ( (ahs_len > ISCSI_MAX_AHS_SIZE) || ((header_digest_size != 0) && (header_digest_size != ISCSI_DIGEST_SIZE)) || ((data_digest_size != 0) && data_digest_size != ISCSI_DIGEST_SIZE) || (ds_len > ISCSI_MAX_DS_SIZE) ) + if ( ds_len > ISCSI_MAX_DS_SIZE ) { + logadd( LOG_ERROR, "iscsi_pdu_create: Invalid DS length" ); return NULL; + } - iscsi_pdu *pdu = (iscsi_pdu *) malloc( sizeof(struct iscsi_pdu) ); + const uint32_t pkt_ds_len = ISCSI_ALIGN( ds_len, ISCSI_ALIGN_SIZE ); + const uint32_t len = (uint32_t) ( sizeof(struct iscsi_bhs_packet) + pkt_ds_len ); + iscsi_pdu *pdu = malloc( sizeof(struct iscsi_pdu) ); if ( pdu == NULL ) { logadd( LOG_ERROR, "iscsi_pdu_create: Out of memory while allocating iSCSI PDU" ); return NULL; } - const uint32_t pkt_ds_len = ISCSI_ALIGN(ds_len, ISCSI_ALIGN_SIZE); - const uint32_t len = (uint32_t) (sizeof(struct iscsi_bhs_packet) + (uint32_t) ahs_len + header_digest_size + pkt_ds_len + ((pkt_ds_len != 0UL) ? (uint32_t) data_digest_size : 0UL)); iscsi_bhs_packet *bhs_pkt = malloc( len ); - if ( bhs_pkt == NULL ) { - logadd( LOG_ERROR, "iscsi_pdu_create: Out of memory while allocating iSCSI PDU packet data" ); - free( pdu ); + logadd( LOG_ERROR, "iscsi_pdu_create: Out of memory while allocating iSCSI BHS packet" ); return NULL; } - pdu->node.succ = NULL; - pdu->node.pred = NULL; pdu->bhs_pkt = bhs_pkt; - pdu->ahs_pkt = ((ahs_len != 0U) ? (iscsi_ahs_packet *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) ) : NULL); - pdu->header_digest = ((header_digest_size != 0) ? (iscsi_header_digest *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) + ahs_len) : NULL); - pdu->ds_cmd_data = ((pkt_ds_len != 0UL) ? (iscsi_scsi_ds_cmd_data *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) + ahs_len + header_digest_size) : NULL); - pdu->data_digest = (((pkt_ds_len != 0uL) && (data_digest_size != 0)) ? (iscsi_data_digest *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) + ahs_len + header_digest_size + ISCSI_ALIGN(pkt_ds_len, ISCSI_ALIGN_SIZE)) : NULL); + pdu->ahs_pkt = NULL; + pdu->ds_cmd_data = (pkt_ds_len != 0UL) ? (iscsi_scsi_ds_cmd_data *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet)) : NULL; pdu->task = NULL; - pdu->conn = conn; - pdu->xfer_complete_callback = NULL; - pdu->xfer_complete_user_data = NULL; pdu->flags = 0; - pdu->ref = 1UL; pdu->bhs_pos = 0U; - pdu->ahs_pos = 0U; - pdu->ahs_len = ahs_len; - pdu->header_digest_pos = 0U; - pdu->header_digest_size = header_digest_size; - pdu->ds_len = pkt_ds_len; - pdu->pos = 0UL; - pdu->len = pkt_ds_len; - pdu->data_digest_pos = 0U; - pdu->data_digest_size = data_digest_size; - pdu->task_ref_cnt = 0U; + pdu->ahs_len = 0; + pdu->ds_len = ds_len; + pdu->ds_write_pos = 0; pdu->cmd_sn = 0UL; + pdu->recv_pos = 0; - if ( pkt_ds_len != 0UL ) + if ( pkt_ds_len != 0UL ) { memset( (((uint8_t *) pdu->ds_cmd_data) + ds_len), 0, (pkt_ds_len - ds_len) ); + } return pdu; } @@ -10912,21 +2933,12 @@ iscsi_pdu *iscsi_connection_pdu_create(iscsi_connection *conn, const uint ahs_le * may be NULL in which case this function * does nothing. */ -void iscsi_connection_pdu_destroy(iscsi_pdu *pdu) +static void iscsi_connection_pdu_destroy(iscsi_pdu *pdu) { - if ( (pdu != NULL) && (--pdu->ref == 0UL) ) { - if ( pdu->bhs_pkt != NULL ) { - free( pdu->bhs_pkt ); - - pdu->bhs_pkt = NULL; - pdu->ahs_pkt = NULL; - pdu->header_digest = NULL; - pdu->ds_cmd_data = NULL; - pdu->data_digest = NULL; - } - - free( pdu ); - } + if ( pdu == NULL ) + return; + free( pdu->bhs_pkt ); + free( pdu ); } /** @@ -10940,32 +2952,29 @@ void iscsi_connection_pdu_destroy(iscsi_pdu *pdu) * the packet data to. May NOT be NULL, so * be careful. * @param[in] ahs_len Length of AHS packet data to be appended. - * @param[in] header_digest_size Length of header digest. Currently, - * only 0, in which case the header digest will - * be removed, or 4 for CRC32C are allowed. * @param[in] ds_len Length of DataSegment packet data to be appended. * May not exceed 16MiB - 1 (16777215 bytes). - * @param[in] data_digest_size Length of optional data digest (0 or - * 4 for now) to add. * @return Pointer to allocated and zero filled PDU or NULL * in case of an error (usually memory exhaustion). */ -iscsi_bhs_packet *iscsi_connection_pdu_append(iscsi_pdu *pdu, const uint ahs_len, const int header_digest_size, const uint32_t ds_len, const int data_digest_size) +static iscsi_bhs_packet *iscsi_connection_pdu_resize(iscsi_pdu *pdu, const uint ahs_len, const uint32_t ds_len) { - if ( (ahs_len > ISCSI_MAX_AHS_SIZE) || ((header_digest_size != 0) && (header_digest_size != ISCSI_DIGEST_SIZE)) || ((data_digest_size != 0) && data_digest_size != ISCSI_DIGEST_SIZE) || (ds_len > ISCSI_MAX_DS_SIZE) ) + if ( (ahs_len > ISCSI_MAX_AHS_SIZE) || (ds_len > ISCSI_MAX_DS_SIZE) || (ahs_len % 4 != 0) ) { + logadd( LOG_ERROR, "iscsi_connection_pdu_resize: Invalid AHS or DataSegment packet size" ); return NULL; + } - if ( (ahs_len != pdu->ahs_len) || (header_digest_size != pdu->header_digest_size) || (ds_len != pdu->ds_len) || (data_digest_size != pdu->data_digest_size) ) { + if ( (ahs_len != pdu->ahs_len) || (ds_len != pdu->ds_len) ) { iscsi_bhs_packet *bhs_pkt; const uint32_t pkt_ds_len = ISCSI_ALIGN(ds_len, ISCSI_ALIGN_SIZE); - const uint32_t old_len = (uint32_t) (sizeof(struct iscsi_bhs_packet) + (uint32_t) pdu->ahs_len + pdu->header_digest_size + pdu->ds_len + ((pdu->ds_len != 0UL) ? (uint32_t) pdu->data_digest_size : 0UL)); - const uint32_t new_len = (uint32_t) (sizeof(struct iscsi_bhs_packet) + (uint32_t) ahs_len + header_digest_size + pkt_ds_len + ((pkt_ds_len != 0UL) ? (uint32_t) data_digest_size : 0UL)); + const uint32_t old_len = (uint32_t) (sizeof(struct iscsi_bhs_packet) + (uint32_t) pdu->ahs_len + ISCSI_ALIGN(pdu->ds_len, ISCSI_ALIGN_SIZE)); + const uint32_t new_len = (uint32_t) (sizeof(struct iscsi_bhs_packet) + (uint32_t) ahs_len + pkt_ds_len); if ( new_len > old_len ) { bhs_pkt = realloc( pdu->bhs_pkt, new_len ); if ( bhs_pkt == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_pdu_append: Out of memory while reallocating iSCSI PDU packet data" ); + logadd( LOG_ERROR, "iscsi_connection_pdu_resize: Out of memory while reallocating iSCSI PDU packet data" ); return NULL; } @@ -10975,332 +2984,20 @@ iscsi_bhs_packet *iscsi_connection_pdu_append(iscsi_pdu *pdu, const uint ahs_len bhs_pkt = pdu->bhs_pkt; } - pdu->ahs_pkt = ((ahs_len != 0U) ? (iscsi_ahs_packet *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) ) : NULL); - pdu->header_digest = ((header_digest_size != 0) ? (iscsi_header_digest *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) + ahs_len) : NULL); - pdu->ds_cmd_data = ((pkt_ds_len != 0UL) ? (iscsi_scsi_ds_cmd_data *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) + ahs_len + header_digest_size) : NULL); - pdu->data_digest = (((pkt_ds_len != 0UL) && (data_digest_size != 0)) ? (iscsi_data_digest *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) + ahs_len + header_digest_size + pkt_ds_len) : NULL); + pdu->ahs_pkt = (ahs_len != 0U) ? (iscsi_ahs_packet *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet)) : NULL; + pdu->ds_cmd_data = (pkt_ds_len != 0UL) ? (iscsi_scsi_ds_cmd_data *) (((uint8_t *) bhs_pkt) + sizeof(struct iscsi_bhs_packet) + ahs_len) : NULL; pdu->ahs_len = ahs_len; - pdu->header_digest_size = header_digest_size; - pdu->ds_len = pkt_ds_len; - pdu->len = pkt_ds_len; - pdu->data_digest_size = data_digest_size; + pdu->ds_len = ds_len; - if ( pkt_ds_len != 0UL ) + if ( pkt_ds_len != 0UL ) { memset( (((uint8_t *) pdu->ds_cmd_data) + ds_len), 0, (pkt_ds_len - ds_len) ); + } } return pdu->bhs_pkt; } /** - * @brief Frees an iSCSI PDU structure used by using connection callback function. - * - * This function frees an iSCSI PDU structure. - * - * @param[in] conn Pointer to iSCSI connection to free - * the PDU from. May NOT be NULL, so take caution. - * @param[in] pdu Pointer to iSCSI PDU structure to be - * freed. NULL is NOT allowed here, so take - * caution. - */ -void iscsi_connection_pdu_free(iscsi_connection *conn, iscsi_pdu *pdu) -{ - iscsi_connection_xfer_complete_callback callback = pdu->xfer_complete_callback; - uint8_t *user_data = pdu->xfer_complete_user_data; - - pdu->xfer_complete_callback = NULL; - - if ( pdu->task != NULL ) - iscsi_task_destroy( pdu->task ); - - iscsi_connection_pdu_destroy( pdu ); - - if ( callback != NULL ) - callback( user_data ); -} - -/** - * @brief Retrieves the pointer to an specific AHS packet from an iSCSI PDU by index. - * - * Gets the pointer of an AHS packet by specified index. - * - * @param[in] pdu Pointer to iSCSI PDU of which the - * AHS packet should be retrieved. May - * NOT be NULL, so be careful. - * @param[in] index Zero-based index number of AHS packet to - * be received. - * @return The pointer to the AHS packet at specified index on - * success or NULL in case of an error or if the specific index - * is out of range. - */ -iscsi_ahs_packet *iscsi_connection_pdu_ahs_packet_get(const iscsi_pdu *pdu, const int index) -{ - iscsi_ahs_packet *ahs_pkt = pdu->ahs_pkt; // First AHS packet - - if ( ahs_pkt == NULL ) - return NULL; - - int count = index; - uint ahs_len = pdu->ahs_len; - - while ( (int) ahs_len > 0 ) { - if ( count-- < 0 ) - return ahs_pkt; - - uint len = iscsi_get_be16(ahs_pkt->len) + offsetof(struct iscsi_ahs_packet, data); // Total length of current AHS packet - - len = ISCSI_ALIGN(len, ISCSI_ALIGN_SIZE); - ahs_len -= len; - ahs_pkt = (iscsi_ahs_packet *) (((uint8_t *) ahs_pkt) + (len - offsetof(struct iscsi_ahs_packet, data))); // Advance pointer to next AHS packet - } - - logadd( LOG_ERROR, "iscsi_connection_pdu_ahs_packet_get: Specified index for AHS packet does not exist" ); - - return NULL; -} - -/** - * @brief Counts number of AHS packets of an iSCSI PDU. - * - * Gets the total number of AHS packets. - * - * @param[in] pdu Pointer to iscsi PDU of which the - * number of AHS packets should be counted. - * May NOT be NULL, so be careful. - * @return The number of AHS packets or 0 if no AHS - * packet data is available. - */ -int iscsi_connection_pdu_ahs_packet_count(const iscsi_pdu *pdu) -{ - const iscsi_ahs_packet *ahs_pkt = pdu->ahs_pkt; // First AHS packet - - if ( ahs_pkt == NULL ) - return 0; - - int count = 0; - uint ahs_len = pdu->ahs_len; - - while ( (int) ahs_len > 0 ) { - uint len = iscsi_get_be16(ahs_pkt->len) + offsetof(struct iscsi_ahs_packet, data); // Total length of current AHS packet - - len = ISCSI_ALIGN(len, ISCSI_ALIGN_SIZE); - ahs_len -= len; - ahs_pkt = (iscsi_ahs_packet *) (((uint8_t *) ahs_pkt) + (len - offsetof(struct iscsi_ahs_packet, data))); // Advance pointer to next AHS packet - count++; - } - - return count; -} - -/// CRC32C lookup table. Created with a polynomial reflect value of 0x82F63B78. -static const uint32_t crc32c_lut[] = { - 0x00000000, 0xF26B8303, 0xE13B70F7, 0x1350F3F4, 0xC79A971F, 0x35F1141C, 0x26A1E7E8, 0xD4CA64EB, - 0x8AD958CF, 0x78B2DBCC, 0x6BE22838, 0x9989AB3B, 0x4D43CFD0, 0xBF284CD3, 0xAC78BF27, 0x5E133C24, - 0x105EC76F, 0xE235446C, 0xF165B798, 0x030E349B, 0xD7C45070, 0x25AFD373, 0x36FF2087, 0xC494A384, - 0x9A879FA0, 0x68EC1CA3, 0x7BBCEF57, 0x89D76C54, 0x5D1D08BF, 0xAF768BBC, 0xBC267848, 0x4E4DFB4B, - 0x20BD8EDE, 0xD2D60DDD, 0xC186FE29, 0x33ED7D2A, 0xE72719C1, 0x154C9AC2, 0x061C6936, 0xF477EA35, - 0xAA64D611, 0x580F5512, 0x4B5FA6E6, 0xB93425E5, 0x6DFE410E, 0x9F95C20D, 0x8CC531F9, 0x7EAEB2FA, - 0x30E349B1, 0xC288CAB2, 0xD1D83946, 0x23B3BA45, 0xF779DEAE, 0x05125DAD, 0x1642AE59, 0xE4292D5A, - 0xBA3A117E, 0x4851927D, 0x5B016189, 0xA96AE28A, 0x7DA08661, 0x8FCB0562, 0x9C9BF696, 0x6EF07595, - 0x417B1DBC, 0xB3109EBF, 0xA0406D4B, 0x522BEE48, 0x86E18AA3, 0x748A09A0, 0x67DAFA54, 0x95B17957, - 0xCBA24573, 0x39C9C670, 0x2A993584, 0xD8F2B687, 0x0C38D26C, 0xFE53516F, 0xED03A29B, 0x1F682198, - 0x5125DAD3, 0xA34E59D0, 0xB01EAA24, 0x42752927, 0x96BF4DCC, 0x64D4CECF, 0x77843D3B, 0x85EFBE38, - 0xDBFC821C, 0x2997011F, 0x3AC7F2EB, 0xC8AC71E8, 0x1C661503, 0xEE0D9600, 0xFD5D65F4, 0x0F36E6F7, - 0x61C69362, 0x93AD1061, 0x80FDE395, 0x72966096, 0xA65C047D, 0x5437877E, 0x4767748A, 0xB50CF789, - 0xEB1FCBAD, 0x197448AE, 0x0A24BB5A, 0xF84F3859, 0x2C855CB2, 0xDEEEDFB1, 0xCDBE2C45, 0x3FD5AF46, - 0x7198540D, 0x83F3D70E, 0x90A324FA, 0x62C8A7F9, 0xB602C312, 0x44694011, 0x5739B3E5, 0xA55230E6, - 0xFB410CC2, 0x092A8FC1, 0x1A7A7C35, 0xE811FF36, 0x3CDB9BDD, 0xCEB018DE, 0xDDE0EB2A, 0x2F8B6829, - 0x82F63B78, 0x709DB87B, 0x63CD4B8F, 0x91A6C88C, 0x456CAC67, 0xB7072F64, 0xA457DC90, 0x563C5F93, - 0x082F63B7, 0xFA44E0B4, 0xE9141340, 0x1B7F9043, 0xCFB5F4A8, 0x3DDE77AB, 0x2E8E845F, 0xDCE5075C, - 0x92A8FC17, 0x60C37F14, 0x73938CE0, 0x81F80FE3, 0x55326B08, 0xA759E80B, 0xB4091BFF, 0x466298FC, - 0x1871A4D8, 0xEA1A27DB, 0xF94AD42F, 0x0B21572C, 0xDFEB33C7, 0x2D80B0C4, 0x3ED04330, 0xCCBBC033, - 0xA24BB5A6, 0x502036A5, 0x4370C551, 0xB11B4652, 0x65D122B9, 0x97BAA1BA, 0x84EA524E, 0x7681D14D, - 0x2892ED69, 0xDAF96E6A, 0xC9A99D9E, 0x3BC21E9D, 0xEF087A76, 0x1D63F975, 0x0E330A81, 0xFC588982, - 0xB21572C9, 0x407EF1CA, 0x532E023E, 0xA145813D, 0x758FE5D6, 0x87E466D5, 0x94B49521, 0x66DF1622, - 0x38CC2A06, 0xCAA7A905, 0xD9F75AF1, 0x2B9CD9F2, 0xFF56BD19, 0x0D3D3E1A, 0x1E6DCDEE, 0xEC064EED, - 0xC38D26C4, 0x31E6A5C7, 0x22B65633, 0xD0DDD530, 0x0417B1DB, 0xF67C32D8, 0xE52CC12C, 0x1747422F, - 0x49547E0B, 0xBB3FFD08, 0xA86F0EFC, 0x5A048DFF, 0x8ECEE914, 0x7CA56A17, 0x6FF599E3, 0x9D9E1AE0, - 0xD3D3E1AB, 0x21B862A8, 0x32E8915C, 0xC083125F, 0x144976B4, 0xE622F5B7, 0xF5720643, 0x07198540, - 0x590AB964, 0xAB613A67, 0xB831C993, 0x4A5A4A90, 0x9E902E7B, 0x6CFBAD78, 0x7FAB5E8C, 0x8DC0DD8F, - 0xE330A81A, 0x115B2B19, 0x020BD8ED, 0xF0605BEE, 0x24AA3F05, 0xD6C1BC06, 0xC5914FF2, 0x37FACCF1, - 0x69E9F0D5, 0x9B8273D6, 0x88D28022, 0x7AB90321, 0xAE7367CA, 0x5C18E4C9, 0x4F48173D, 0xBD23943E, - 0xF36E6F75, 0x0105EC76, 0x12551F82, 0xE03E9C81, 0x34F4F86A, 0xC69F7B69, 0xD5CF889D, 0x27A40B9E, - 0x79B737BA, 0x8BDCB4B9, 0x988C474D, 0x6AE7C44E, 0xBE2DA0A5, 0x4C4623A6, 0x5F16D052, 0xAD7D5351}; - -/** - * @brief Calculates digest (CRC32C). - * - * Calculates CRC32C with 0x82F63B78 polynomial - * reflect according to iSCSI specs.\n - * TODO: Implement optimized SSE4.2 and ARM versions - * - * @param[in] data Pointer to data to calculate CRC32C for. - * @param[in] len Length of data to be calculated. Must be - * divisable by 4 which is guaranteed by iSCSI standard. - * @param[in] crc32c Previous CRC32C in case of multiple passes. - * @return CRC32C value. THis function cannot fail. - */ -static inline uint32_t iscsi_crc32c_update(const uint8_t *data, const uint len, uint32_t crc32c) -{ - for ( uint i = 0; i < len; i += 4 ) { - crc32c = (crc32c >> 8UL) ^ crc32c_lut[(crc32c ^ data[i]) & 0xFF]; - crc32c = (crc32c >> 8UL) ^ crc32c_lut[(crc32c ^ data[i + 1]) & 0xFF]; - crc32c = (crc32c >> 8UL) ^ crc32c_lut[(crc32c ^ data[i + 2]) & 0xFF]; - crc32c = (crc32c >> 8UL) ^ crc32c_lut[(crc32c ^ data[i + 3]) & 0xFF]; - } - - return crc32c; -} - -/** - * @brief Calculate and store iSCSI header digest (CRC32C). - * - * Calculates header digest (CRC32C) with - * 0x82F63B78 polynomial reflect according - * to iSCSI specs and stores the result in - * the iSCSI packet data. This function - * cannot fail. - * - * @param[out] header_digest Pointer to iSCSI header digest - * packet data to put CRC32C into. - * May NOT be NULL, so be careful. - * @param[in] packet_data Pointer to ISCSI BHS packet to - * calculate CRC32C for. NULL is NOT - * allowed here, take caution. - * @param[in] ahs_len AHS segment length in bytes. - */ -void iscsi_connection_pdu_digest_header_update(iscsi_header_digest *header_digest, const iscsi_bhs_packet *packet_data, const uint ahs_len) -{ - const uint32_t crc32c = iscsi_crc32c_update( (uint8_t *) packet_data, (sizeof(struct iscsi_bhs_packet) + ahs_len), ISCSI_CRC32C_INITIAL ) ^ ISCSI_CRC32C_XOR; - - iscsi_put_le32( (uint8_t *) &header_digest->crc32c, crc32c ); -} - -/** - * @brief Validates a stored iSCSI header digest (CRC32C) with actual header data. - * - * Verifies header digest (CRC32C) with - * 0x82F63B78 polynomial reflect according - * to iSCSI specs. This function cannot - * fail. - * - * @param[in] header_digest Pointer to iSCSI header digest - * packet data to compare CRC32C with. - * May NOT be NULL, so be careful. - * @param[in] packet_data Pointer to ISCSI BHS packet to - * validate CRC32C for. May NOT be NULL, - * so be careful. - * @param[in] ahs_len AHS segment length in bytes. - * @retval true CRC32C matches the stored value. - * @retval false CRC32C does NOT match the stored value. - */ -bool iscsi_connection_pdu_digest_header_verify(const iscsi_header_digest *header_digest, const iscsi_bhs_packet *packet_data, const uint ahs_len) -{ - const uint32_t crc32c = iscsi_crc32c_update( (uint8_t *) packet_data, (sizeof(struct iscsi_bhs_packet) + ahs_len), ISCSI_CRC32C_INITIAL ) ^ ISCSI_CRC32C_XOR; - - return (iscsi_get_le32(crc32c) == header_digest->crc32c); -} - -/** - * @brief Calculate iSCSI data digest (CRC32C). - * - * Calculates data digest (CRC32) with - * 0x82F63B78 polynomial reflect of a - * whole DataSegment (CRC32C) according - * to the iSCSI specs.\n - * The resulting CRC32C will be stored - * in the iSCSI packet. - * - * @param[out] data_digest Pointer to iSCSI data digest - * packet data to put CRC32C into. - * May NOT be NULL, so be careful. - * @param[in] ds_cmd_data Pointer to iSCSI DataSegment packet to - * calculate CRC32C for. NULL is NOT - * allowed here, take caution. - * @param[in] ds_len Data segment length in bytes. - */ -void iscsi_connection_pdu_digest_data_update(iscsi_data_digest *data_digest, const iscsi_scsi_ds_cmd_data *ds_cmd_data, const uint32_t ds_len) -{ - const uint32_t crc32c = iscsi_crc32c_update( (uint8_t *) ds_cmd_data, ISCSI_ALIGN(ds_len, ISCSI_DIGEST_SIZE), ISCSI_CRC32C_INITIAL ) ^ ISCSI_CRC32C_XOR; - - iscsi_put_le32( (uint8_t *) &data_digest->crc32c, crc32c ); -} - -/** - * @brief Validates a stored iSCSI data digest (CRC32C) with actual DataSegment. - * - * Verifies data digest (CRC32C) with - * 0x82F63B78 polynomial reflect according - * to iSCSI specs. This function cannot - * fail. - * - * @param[out] data_digest Pointer to iSCSI data digest - * packet data to compare CRC32C with. - * May NOT be NULL, so be careful. - * @param[in] ds_cmd_data Pointer to iSCSI DataSegment - * packet to calculate CRC32C for. May NOT - * be NULL, so be careful. - * @param[in] ds_len Data segment length in bytes. - * @retval true CRC32C matches the stored value. - * @retval false CRC32C does NOT match the stored value. - */ -bool iscsi_connection_pdu_digest_data_verify(const iscsi_data_digest *data_digest, const iscsi_scsi_ds_cmd_data *ds_cmd_data, const uint32_t ds_len) -{ - const uint32_t crc32c = iscsi_crc32c_update( (uint8_t *) ds_cmd_data, ISCSI_ALIGN(ds_len, ISCSI_DIGEST_SIZE), ISCSI_CRC32C_INITIAL ) ^ ISCSI_CRC32C_XOR; - - return (iscsi_get_le32(crc32c) == data_digest->crc32c); -} - -/** - * @brief Checks whether iSCSI PDU cleanup procedure has to be deferred. - * - * This function checks whether the cleanup - * process of a written PDU has to be - * deferred to a later stage. - * - * @param[in] pdu Pointer to iSCSI PDU to be checked for - * deferrred cleanup processs. - * @retval true The PDUs cleanup stage has to be - * deferred to a later stage. - * @retval false The PDU can be cleaned up immediately. - */ -static inline bool iscsi_connection_pdu_free_is_deferred(const iscsi_pdu *pdu) -{ - return ((pdu != NULL) && ((pdu->bhs_pkt->opcode == ISCSI_OPCODE_SERVER_READY_XFER) || (pdu->bhs_pkt->opcode == ISCSI_OPCODE_SERVER_SCSI_DATA_IN))); -} - -/** - * @brief Handles iSCSI PDU cleanup after the PDU has been sent via TCP/IP to the client. - * - * This function checks whether there are PDU - * cleanup actions required and either frees - * the PDU or adds it to the PDU Sequence - * Number Acknowledgement (SNACK) list. - * - * @param[in] user_data Pointer to iSCSI PDU which completed - * the TCP/IP write. May NOT be NULL, so be - * careful. - */ -static void iscsi_connection_pdu_write_complete(uint8_t *user_data, int err) -{ - iscsi_pdu *pdu = (iscsi_pdu *) user_data; - iscsi_connection *conn = pdu->conn; - - if ( conn->state >= ISCSI_CONNECT_STATE_EXITING ) - return; - - iscsi_list_remove( &pdu->node ); - - if ( err != 0 ) - conn->state = ISCSI_CONNECT_STATE_EXITING; - - if ( ((conn->flags & ISCSI_CONNECT_FLAGS_FULL_FEATURE) != 0) && (conn->session->err_recovery_level > 0UL) && iscsi_connection_pdu_free_is_deferred( pdu ) ) - iscsi_list_enqueue( &conn->pdus_snack, &pdu->node ); - else - iscsi_connection_pdu_free( conn, pdu ); -} - -/** * @brief Writes and sends a response PDU to the client. * * This function sends a response PDU to the @@ -11309,50 +3006,30 @@ static void iscsi_connection_pdu_write_complete(uint8_t *user_data, int err) * be calculated, this is done as well. * * @param[in] conn Pointer to iSCSI connection to handle. May - * NOT be NULL, so take caution. + * NOT be NULL, so take caution. Will be freed after sending, + * so don't access afterwards. * @param[in] pdu Pointer to iSCSI server response PDU to send. * May NOT be NULL, so be careful. - * @param[in] callback Callback function to be invoked - * after TCP/IP packet has been sent successfully. - * May be NULL in case no further action is required. - * @param[in,out] user_data Data for the callback - * function. May be NULL if the callback function - * doesn't require additional data. */ -void iscsi_connection_pdu_write(iscsi_connection *conn, iscsi_pdu *pdu, iscsi_connection_xfer_complete_callback callback, uint8_t *user_data) +static bool iscsi_connection_pdu_write(iscsi_connection *conn, iscsi_pdu *pdu) { - if ( ISCSI_GET_OPCODE(pdu->bhs_pkt->opcode) != ISCSI_OPCODE_CLIENT_LOGIN_REQ ) { - if ( pdu->header_digest != NULL ) - iscsi_connection_pdu_digest_header_update( pdu->header_digest, pdu->bhs_pkt, pdu->ahs_len ); - - if ( pdu->data_digest != NULL ) - iscsi_connection_pdu_digest_data_update( pdu->data_digest, pdu->ds_cmd_data, pdu->ds_len ); + if ( conn->state >= ISCSI_CONNECT_STATE_EXITING ) { + iscsi_connection_pdu_destroy( pdu ); + return false; } - pdu->xfer_complete_callback = callback; - pdu->xfer_complete_user_data = user_data; - - iscsi_list_enqueue( &conn->pdus_write, &pdu->node ); + // During allocation we already round up to ISCSI_ALIGN_SIZE, but store the requested size in the ds_len + // member, so it's safe to round up here before sending, the accessed memory will be valid and zeroed + const size_t len = (sizeof(struct iscsi_bhs_packet) + pdu->ahs_len + ISCSI_ALIGN(pdu->ds_len, ISCSI_ALIGN_SIZE)); + const ssize_t rc = sock_sendAll( conn->client->sock, pdu->bhs_pkt, len, ISCSI_CONNECT_SOCKET_WRITE_RETRIES ); - if ( conn->state >= ISCSI_CONNECT_STATE_EXITING ) - return; - - const uint32_t len = (uint) (sizeof(struct iscsi_bhs_packet) + pdu->ahs_len + conn->header_digest + ISCSI_ALIGN(pdu->ds_len, ISCSI_ALIGN_SIZE) + conn->data_digest); - const int32_t rc = iscsi_connection_write( conn, (uint8_t *) pdu->bhs_pkt, len ); - iscsi_connection_exec_queue *exec_queue = (iscsi_connection_exec_queue *) malloc( sizeof(struct iscsi_connection_exec_queue) ); - - if ( exec_queue == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_pdu_write: Out of memory while allocating execution queue for PDU write" ); + iscsi_connection_pdu_destroy( pdu ); - return; + if ( rc != (ssize_t)len ) { + conn->state = ISCSI_CONNECT_STATE_EXITING; + return false; } - - exec_queue->data.pdu_write.callback = iscsi_connection_pdu_write_complete; - exec_queue->data.pdu_write.user_data = (uint8_t *) pdu; - exec_queue->data.pdu_write.err = ((rc == (int32_t) len) ? 0 : -1); - exec_queue->type = ISCSI_CONNECT_EXEC_QUEUE_TYPE_PDU_WRITE; - - iscsi_list_enqueue( &conn->exec_queue, &exec_queue->node ); + return true; } /** @@ -11394,34 +3071,6 @@ static inline int iscsi_seq_num_cmp_gt(const uint32_t seq_num, const uint32_t se } /** - * @brief Removes an acknowledged PDU from SNACK PDU doubly linked list by ExpStatSN. - * - * This function is invoked when ExpStatSN becomes - * invalid. - * - * @param[in] conn Pointer to iSCSI connection to be removed, - * may NOT be NULL, so be careful. - * @param[in] exp_stat_sn First ExpStatSN to not to be removed. - */ -void iscsi_connection_pdu_ack_remove(iscsi_connection *conn, const uint32_t exp_stat_sn) -{ - conn->exp_stat_sn = ((exp_stat_sn < conn->stat_sn) ? exp_stat_sn : conn->stat_sn); - - iscsi_pdu *pdu; - iscsi_pdu *tmp; - - iscsi_list_foreach_safe_node ( &conn->pdus_snack, pdu, tmp ) { - iscsi_scsi_response_packet *scsi_response_pkt = (iscsi_scsi_response_packet *) pdu->bhs_pkt; - const uint32_t stat_sn = iscsi_get_be32(scsi_response_pkt->stat_sn); - - if ( iscsi_seq_num_cmp_lt( stat_sn, conn->exp_stat_sn ) ) { - iscsi_list_remove( &pdu->node ); - iscsi_connection_pdu_free( conn, pdu ); - } - } -} - -/** * @brief Constructs and sends an iSCSI reject response to the client. * * This function constructs an reject response PDU with its @@ -11432,7 +3081,7 @@ void iscsi_connection_pdu_ack_remove(iscsi_connection *conn, const uint32_t exp_ * @param[in] conn Pointer to iSCSI connection for reject packet construction. * @param[in] pdu Pointer to iSCSI source PDU which contains the rejected packet data. * @param[in] reason_code Reason code for rejected packet data. - * @retval -1 An error occured during reject packet generation, + * @retval -1 An error ocurred during reject packet generation, * currently only happens on memory exhaustion. * @retval 0 Reject packet and PDU constructed and sent successfully to the client. */ @@ -11441,7 +3090,7 @@ static int iscsi_connection_handle_reject(iscsi_connection *conn, iscsi_pdu *pdu pdu->flags |= ISCSI_PDU_FLAGS_REJECTED; const uint32_t ds_len = (uint32_t) sizeof(struct iscsi_bhs_packet) + ((uint32_t) pdu->bhs_pkt->total_ahs_len << 2UL); - iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, ds_len, conn->data_digest ); + iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, ds_len ); if ( response_pdu == NULL ) { logadd( LOG_ERROR, "iscsi_connection_handle_reject: Out of memory while allocating iSCSI reject response PDU" ); @@ -11473,7 +3122,7 @@ static int iscsi_connection_handle_reject(iscsi_connection *conn, iscsi_pdu *pdu memcpy( response_pdu->ds_cmd_data, pdu->bhs_pkt, ds_len ); - iscsi_connection_pdu_write( conn, response_pdu, NULL, NULL ); + iscsi_connection_pdu_write( conn, response_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } @@ -11504,12 +3153,18 @@ static int iscsi_connection_update_cmd_sn(iscsi_connection *conn, iscsi_pdu *pdu pdu->cmd_sn = iscsi_get_be32(scsi_cmd_pkt->cmd_sn); - if ( session->err_recovery_level == 0UL ) { - if ( (scsi_cmd_pkt->opcode & ISCSI_OPCODE_FLAGS_IMMEDIATE) == 0 ) { - if ( (iscsi_seq_num_cmp_lt( pdu->cmd_sn, session->exp_cmd_sn ) || iscsi_seq_num_cmp_gt( pdu->cmd_sn, session->max_cmd_sn )) && ((session->type == ISCSI_SESSION_TYPE_NORMAL) && (opcode != ISCSI_OPCODE_CLIENT_SCSI_DATA_OUT)) ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } else if ( (pdu->cmd_sn != session->exp_cmd_sn) && (opcode != ISCSI_OPCODE_CLIENT_NOP_OUT) ) + if ( (scsi_cmd_pkt->opcode & ISCSI_OPCODE_FLAGS_IMMEDIATE) == 0 ) { + if ( (iscsi_seq_num_cmp_lt( pdu->cmd_sn, session->exp_cmd_sn ) + || iscsi_seq_num_cmp_gt( pdu->cmd_sn, session->max_cmd_sn )) + && ((session->type == ISCSI_SESSION_TYPE_NORMAL) && (opcode != ISCSI_OPCODE_CLIENT_SCSI_DATA_OUT)) ) { + logadd( LOG_WARNING, "Seqnum messup. Is: %u, want >= %u, < %u", + pdu->cmd_sn, session->exp_cmd_sn, session->max_cmd_sn ); return ISCSI_CONNECT_PDU_READ_ERR_FATAL; + } + } else if ( (pdu->cmd_sn != session->exp_cmd_sn) && (opcode != ISCSI_OPCODE_CLIENT_NOP_OUT) ) { + logadd( LOG_WARNING, "Seqnum messup. Is: %u, want: %u", + pdu->cmd_sn, session->exp_cmd_sn ); + return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } uint32_t exp_stat_sn = iscsi_get_be32(scsi_cmd_pkt->exp_stat_sn); @@ -11517,9 +3172,6 @@ static int iscsi_connection_update_cmd_sn(iscsi_connection *conn, iscsi_pdu *pdu if ( iscsi_seq_num_cmp_gt( exp_stat_sn, conn->stat_sn ) ) exp_stat_sn = conn->stat_sn; - if ( session->err_recovery_level > 0UL ) - iscsi_connection_pdu_ack_remove( conn, exp_stat_sn ); - if ( ((scsi_cmd_pkt->opcode & ISCSI_OPCODE_FLAGS_IMMEDIATE) == 0) && (opcode != ISCSI_OPCODE_CLIENT_SCSI_DATA_OUT) ) session->exp_cmd_sn++; @@ -11543,7 +3195,8 @@ static int iscsi_connection_update_cmd_sn(iscsi_connection *conn, iscsi_pdu *pdu */ static int iscsi_connection_pdu_header_handle_login_req(iscsi_connection *conn, iscsi_pdu *pdu) { - if ( ((conn->flags & ISCSI_CONNECT_FLAGS_FULL_FEATURE) != 0) && (conn->session != NULL) && (conn->session->type == ISCSI_SESSION_TYPE_DISCOVERY) ) + if ( ((conn->flags & ISCSI_CONNECT_FLAGS_FULL_FEATURE) != 0) && (conn->session != NULL) + && (conn->session->type == ISCSI_SESSION_TYPE_DISCOVERY) ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; const iscsi_login_req_packet *login_req_pkt = (iscsi_login_req_packet *) pdu->bhs_pkt; @@ -11553,7 +3206,7 @@ static int iscsi_connection_pdu_header_handle_login_req(iscsi_connection *conn, if ( pdu->ds_len > ISCSI_DEFAULT_RECV_DS_LEN ) return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - iscsi_pdu *login_response_pdu = iscsi_connection_pdu_create( conn, 0U, 0, ISCSI_DEFAULT_RECV_DS_LEN, 0 ); + iscsi_pdu *login_response_pdu = iscsi_connection_pdu_create( conn, 8192 ); if ( login_response_pdu == NULL ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; @@ -11561,7 +3214,7 @@ static int iscsi_connection_pdu_header_handle_login_req(iscsi_connection *conn, const int rc = iscsi_connection_pdu_login_response_init( login_response_pdu, pdu ); if ( rc < 0 ) { - iscsi_connection_pdu_login_response( conn, login_response_pdu, NULL, iscsi_connection_pdu_login_err_complete ); + iscsi_connection_pdu_login_response( conn, login_response_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } @@ -11624,46 +3277,17 @@ static int iscsi_connection_pdu_header_handle_nop_out(iscsi_connection *conn, is */ static int iscsi_connection_pdu_header_handle_scsi_cmd(iscsi_connection *conn, iscsi_pdu *pdu) { - iscsi_scsi_cmd_packet *stat_scsi_cmd_pkt = (iscsi_scsi_cmd_packet *) pdu->bhs_pkt; - uint64_t stat_opcode = (uint64_t) stat_scsi_cmd_pkt->scsi_cdb.opcode; - uint64_t *stat_value = NULL; - int stat_rc = iscsi_hashmap_get( conn->stat_scsi_opcodes, (uint8_t *) &stat_opcode, sizeof(stat_opcode), (uint8_t **) &stat_value ); - - if ( stat_value == NULL ) { - stat_value = malloc( sizeof(uint64_t) ); - - if ( stat_value != NULL ) { - uint8_t *stat_key = iscsi_hashmap_key_create( (uint8_t *) &stat_opcode, sizeof(stat_opcode) ); - - if ( stat_key != NULL ) { - *stat_value = 0ULL; - - stat_rc = iscsi_hashmap_put( conn->stat_scsi_opcodes, stat_key, sizeof(stat_opcode), (uint8_t *) stat_value ); - - if ( stat_rc < 0 ) { - iscsi_hashmap_key_destroy( stat_key ); - free( stat_value ); - stat_value = NULL; - } - } else { - free( stat_value ); - stat_value = NULL; - } - } - } - - if ( stat_value != NULL ) - (*stat_value)++; - if ( conn->session->type != ISCSI_SESSION_TYPE_NORMAL ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; iscsi_scsi_cmd_packet *scsi_cmd_pkt = (iscsi_scsi_cmd_packet *) pdu->bhs_pkt; - if ( (scsi_cmd_pkt->flags_task & (ISCSI_SCSI_CMD_FLAGS_TASK_READ | ISCSI_SCSI_CMD_FLAGS_TASK_WRITE)) == (ISCSI_SCSI_CMD_FLAGS_TASK_READ | ISCSI_SCSI_CMD_FLAGS_TASK_WRITE) ) // Bidirectional transfer is not supported + if ( (scsi_cmd_pkt->flags_task & (ISCSI_SCSI_CMD_FLAGS_TASK_READ | ISCSI_SCSI_CMD_FLAGS_TASK_WRITE)) + == (ISCSI_SCSI_CMD_FLAGS_TASK_READ | ISCSI_SCSI_CMD_FLAGS_TASK_WRITE) ) { // Bidirectional transfer is not supported return ISCSI_CONNECT_PDU_READ_ERR_FATAL; + } - iscsi_task *task = iscsi_task_create( conn, NULL, iscsi_scsi_task_xfer_complete ); + iscsi_task *task = iscsi_task_create( conn ); if ( task == NULL ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; @@ -11674,29 +3298,10 @@ static int iscsi_connection_pdu_header_handle_scsi_cmd(iscsi_connection *conn, i task->scsi_task.len = (uint) (((uint8_t *) pdu->ds_cmd_data) - ((uint8_t *) pdu->bhs_pkt)); task->scsi_task.cdb = &scsi_cmd_pkt->scsi_cdb; task->scsi_task.xfer_len = exp_xfer_len; - task->scsi_task.target_port = conn->target_port; - task->scsi_task.init_port = conn->init_port; task->init_task_tag = iscsi_get_be32(scsi_cmd_pkt->init_task_tag); - task->pdu = pdu; - pdu->ref++; const uint64_t lun = iscsi_get_be64(scsi_cmd_pkt->lun); - const int lun_id = iscsi_scsi_lun_get_from_iscsi( lun ); - - task->lun_id = lun_id; - - pthread_rwlock_rdlock( &conn->device->luns_rwlock ); - - task->scsi_task.lun = iscsi_device_find_lun( conn->device, lun_id ); - - pthread_rwlock_unlock( &conn->device->luns_rwlock ); - - if ( task->scsi_task.lun == NULL ) { - iscsi_scsi_task_lun_process_none( &task->scsi_task ); - iscsi_scsi_task_xfer_complete( &task->scsi_task ); - - return ISCSI_CONNECT_PDU_READ_OK; - } + task->lun_id = iscsi_scsi_lun_get_from_iscsi( lun ); if ( ((scsi_cmd_pkt->flags_task & (ISCSI_SCSI_CMD_FLAGS_TASK_READ | ISCSI_SCSI_CMD_FLAGS_TASK_WRITE)) == 0) && (exp_xfer_len > 0UL) ) { iscsi_task_destroy( task ); @@ -11704,42 +3309,11 @@ static int iscsi_connection_pdu_header_handle_scsi_cmd(iscsi_connection *conn, i return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_INVALID_PDU_FIELD ); } - if ( (scsi_cmd_pkt->flags_task & ISCSI_SCSI_CMD_FLAGS_TASK_READ) != 0 ) { + if ( (scsi_cmd_pkt->flags_task & ISCSI_SCSI_CMD_FLAGS_TASK_READ) != 0 ) task->scsi_task.flags |= ISCSI_SCSI_TASK_FLAGS_XFER_READ; - } else if ( (scsi_cmd_pkt->flags_task & ISCSI_SCSI_CMD_FLAGS_TASK_WRITE) != 0 ) { - task->scsi_task.flags |= ISCSI_SCSI_TASK_FLAGS_XFER_WRITE; - - if ( (conn->session->err_recovery_level > 0UL) && (iscsi_r2t_find_pdu_bhs( conn, pdu ) != NULL) ) { - iscsi_task_response( conn, task ); - iscsi_task_destroy( task ); - return ISCSI_CONNECT_PDU_READ_OK; - } - - if ( pdu->ds_len > (uint) (sizeof(struct iscsi_bhs_packet) + ISCSI_MAX_AHS_SIZE + conn->header_digest + iscsi_globvec->first_burst_len + conn->data_digest) ) { - iscsi_task_destroy( task ); - - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - } - - if ( pdu->ds_len > exp_xfer_len ) { - iscsi_task_destroy( task ); - - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - } - - if ( (((conn->session->flags & ISCSI_SESSION_FLAGS_IMMEDIATE_DATA) == 0) && (pdu->ds_len > 0UL)) || (pdu->ds_len > conn->session->first_burst_len) ) { - iscsi_task_destroy( task ); - - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - } - - if ( ((scsi_cmd_pkt->flags_task & ISCSI_SCSI_CMD_FLAGS_FINAL) != 0) && (pdu->ds_len < exp_xfer_len) ) { - if ( exp_xfer_len > ISCSI_DEFAULT_MAX_RECV_DS_LEN ) - exp_xfer_len = ISCSI_DEFAULT_MAX_RECV_DS_LEN; - - pdu->len = exp_xfer_len; - } + if ( (scsi_cmd_pkt->flags_task & ISCSI_SCSI_CMD_FLAGS_TASK_WRITE) != 0 ) { + return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_COMMAND_NOT_SUPPORTED ); } pdu->task = task; @@ -11748,28 +3322,6 @@ static int iscsi_connection_pdu_header_handle_scsi_cmd(iscsi_connection *conn, i } /** - * @brief Handles an incoming iSCSI header task management function request PDU. - * - * This function handles task management function - * request header data sent by the client.\n - * If a response needs to be sent, this will - * be done as well. - * - * @param[in] conn Pointer to iSCSI connection to handle. May - * NOT be NULL, so take caution. - * @param[in] pdu Pointer to iSCSI client request PDU to handle. - * May be NULL in which case an error is returned. - * @return 0 on success. A negative value indicates - * an error. A positive value a warning. - */ -static int iscsi_connection_pdu_header_handle_task_func_req(iscsi_connection *conn, iscsi_pdu *pdu) -{ - // TODO: Implement opcode. - - return 0; -} - -/** * @brief Handles an incoming iSCSI header text request PDU. * * This function handles text request header @@ -11786,7 +3338,7 @@ static int iscsi_connection_pdu_header_handle_task_func_req(iscsi_connection *co */ static int iscsi_connection_pdu_header_handle_text_req(iscsi_connection *conn, iscsi_pdu *pdu) { - if ( pdu->ds_len > (uint) (sizeof(struct iscsi_bhs_packet) + ISCSI_MAX_AHS_SIZE + conn->header_digest + iscsi_globvec->first_burst_len + conn->data_digest) ) + if ( pdu->ds_len > (uint) (sizeof(struct iscsi_bhs_packet) + ISCSI_DEFAULT_RECV_DS_LEN) ) return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); iscsi_text_req_packet *text_req_pkt = (iscsi_text_req_packet *) pdu->bhs_pkt; @@ -11797,315 +3349,16 @@ static int iscsi_connection_pdu_header_handle_text_req(iscsi_connection *conn, i if ( exp_stat_sn != conn->stat_sn ) conn->stat_sn = exp_stat_sn; - if ( (text_req_pkt->flags & (ISCSI_TEXT_REQ_FLAGS_CONTINUE | ISCSI_TEXT_REQ_FLAGS_FINAL)) == (ISCSI_TEXT_REQ_FLAGS_CONTINUE | ISCSI_TEXT_REQ_FLAGS_FINAL) ) + if ( (text_req_pkt->flags & (ISCSI_TEXT_REQ_FLAGS_CONTINUE | ISCSI_TEXT_REQ_FLAGS_FINAL)) + == (ISCSI_TEXT_REQ_FLAGS_CONTINUE | ISCSI_TEXT_REQ_FLAGS_FINAL) ) { return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - if ( conn->session->current_text_init_task_tag == 0xFFFFFFFFUL ) - conn->session->current_text_init_task_tag = init_task_tag; - else - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Searches an iSCSI PDU by Basic Header Segment (BHS) in the Ready To Transfer (R2T) active and queued task hash map. - * - * This function searches for an iSCSI PDU by - * iterating through the iSCSI connection active - * and queued Ready To Transfer tasks hash map. - * - * @param[in] conn Pointer to iSCSI connection to - * search in the active and queued Ready To - * Transfer tasks hash map. May NOT be NULL, so - * be careful. - * @param[in] pdu Pointer to iSCSI PDU of which - * the Basic Header Segment (BHS) should be - * searched for. NULL is NOT allowed here, so - * take caution. - * @return Pointer to found iSCSI PDU or NULL in - * case neither an iSCSI active nor enqueued - * Ready To Transfer (R2T) task has a matching - * Basic Header Segment (BHS). - */ -iscsi_pdu *iscsi_r2t_find_pdu_bhs(iscsi_connection *conn, iscsi_pdu *pdu) -{ - iscsi_task *task; - - iscsi_list_foreach_node ( &conn->r2t_tasks_active, task ) { - if ( memcmp( task->pdu->bhs_pkt, pdu->bhs_pkt, sizeof(struct iscsi_bhs_packet) ) == 0 ) - return task->pdu; } - iscsi_list_foreach_node ( &conn->r2t_tasks_queue, task ) { - if ( memcmp( task->pdu->bhs_pkt, pdu->bhs_pkt, sizeof(struct iscsi_bhs_packet) ) == 0 ) - return task->pdu; - } - - return NULL; -} - -/** - * @brief Sends an iSCSI Ready To Transfer Sequence Number (R2TSN) packet to the initiator. - * - * This function allocates and initializes a - * Ready To Transfer Sequence Number (R2TSN) - * packet to be sent to the client. - * - * @param[in] conn Pointer to iSCSI connection which - * maintains the R2TSN, may NOT be NULL, - * so be careful. - * @param[in] task Pointer to iSCSI task handling - * the R2TSN. NULL is NOT allowed here, - * take caution. - * @param[in,out] r2t_sn Pointer to 32-bit integer containing - * the R2TSN which is incremented after - * storing it in the response packet data. - * NULL is prohibited, so take caution. - * @param[in] pos Offset in bytes of transfer data. - * @param[in] len Length in bytes of transfer data. - * @param[in] target_xfer_tag Target Transfer Tag (TTT) for data. - * @return 0 on successful packet sending, a negative - * error code otherwise. - */ -int iscsi_r2t_send(iscsi_connection *conn, iscsi_task *task, uint32_t *r2t_sn, const uint32_t pos, const uint32_t len, const uint32_t target_xfer_tag) -{ - iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, 0UL, conn->data_digest ); - - if ( response_pdu == NULL ) { - logadd( LOG_ERROR, "iscsi_r2t_send: Out of memory while allocating iSCSI Ready To Transfer response PDU" ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - iscsi_r2t_packet *r2t_pkt = (iscsi_r2t_packet *) response_pdu->bhs_pkt; - - r2t_pkt->opcode = ISCSI_OPCODE_SERVER_READY_XFER; - r2t_pkt->flags = -0x80; - r2t_pkt->reserved = 0U; - *(uint32_t *) &r2t_pkt->total_ahs_len = 0UL; // TotalAHSLength and DataSegmentLength are always 0, so write in one step. - - const uint64_t lun = iscsi_scsi_lun_get_from_scsi( task->lun_id ); - - iscsi_put_be64( (uint8_t *) &r2t_pkt->lun, lun ); - iscsi_put_be32( (uint8_t *) &r2t_pkt->init_task_tag, task->init_task_tag ); - iscsi_put_be32( (uint8_t *) &r2t_pkt->target_xfer_tag, target_xfer_tag ); - iscsi_put_be32( (uint8_t *) &r2t_pkt->stat_sn, conn->stat_sn ); - iscsi_put_be32( (uint8_t *) &r2t_pkt->exp_cmd_sn, conn->session->exp_cmd_sn ); - iscsi_put_be32( (uint8_t *) &r2t_pkt->max_cmd_sn, conn->session->max_cmd_sn ); - r2t_pkt->data_sn = 0UL; - iscsi_put_be32( (uint8_t *) &r2t_pkt->r2t_sn, (*r2t_sn)++ ); - - task->r2t_data_sn = 0UL; - - iscsi_put_be32( (uint8_t *) &r2t_pkt->buf_offset, (uint32_t) pos ); - iscsi_put_be32( (uint8_t *) &r2t_pkt->des_data_xfer_len, (uint32_t) len ); - - response_pdu->task = task; - task->scsi_task.ref++; - - iscsi_connection_pdu_write( conn, response_pdu, NULL, NULL ); - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Searches an iSCSI PDU task by Ready To Transfer Sequence Number (R2TSN) and removes it from PDU SNACK doubly linked list. - * - * This function searches for an iSCSI PDU task - * by iterating through the iSCSI connection - * Sequence Number Acknowledgement (SNACK) - * and matches the Ready To Transfer Sequence - * Number (R2TSN).\n - * If found, the PDU will be removed from the - * PDU SNACK doubly linked list. - * - * @param[in] conn Pointer to iSCSI connection to - * search in the Sequence Number - * Acknowledgement (SNACK) hash map. May NOT be - * NULL, so be careful. - * @param[in] task Pointer to iSCSI task to search - * for in the Sequence Number Acknowledgement - * (SNACK) hash map. NULL is not allowed here, - * take caution. - * @param[in] r2t_sn Ready To Transfer Sequence Number - * (R2TSN) to be searched for. - * @return Pointer to found iSCSI PDU or NULL in - * case no iSCSI PDU has a matching Ready To Transfer - * Sequence Number (R2TSN). - */ -static iscsi_pdu *iscsi_r2t_remove_pdu_from_snack_list(iscsi_connection *conn, iscsi_task *task, const uint32_t r2t_sn) -{ - iscsi_pdu *pdu; - - iscsi_list_foreach_node ( &conn->pdus_snack, pdu ) { - if ( pdu->bhs_pkt->opcode == ISCSI_OPCODE_SERVER_READY_XFER ) { - iscsi_r2t_packet *r2t_pkt = (iscsi_r2t_packet *) pdu->bhs_pkt; - - if ( (pdu->task == task) && (iscsi_get_be32(r2t_pkt->r2t_sn) == r2t_sn) ) { - iscsi_list_remove( &pdu->node ); - - return pdu; - } - } - } - - return NULL; -} - -/** - * @brief Resends the Ready To Transfer (R2T) packet data. - * - * This function either sends a new R2T packet or - * resends an already sent one. - * - * @param[in] conn Pointer to iSCSI connection to send the - * R2T packet for, may NOT be NULL, so be careful. - * @param[in] task Pointer to iSCSI task responsible for - * sending the R2T packet. NULL is NOT allowed - * here, take caution. - * @param[in] r2t_sn_ack R2TSN acknowledged number. - * @param[in] r2t_sn_send_new 0 resends an already sent - * R2T packet, any other value will send a new - * packet. - * @return 0 if packet was sent successfully, a negative - * error code otherwise. - */ -static int iscsi_r2t_recovery_send(iscsi_connection *conn, iscsi_task *task, const uint32_t r2t_sn_ack, const int r2t_sn_send_new) -{ - iscsi_pdu *pdu = iscsi_r2t_remove_pdu_from_snack_list( conn, task, r2t_sn_ack ); - - if ( pdu == NULL ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - iscsi_r2t_packet *r2t_pkt = (iscsi_r2t_packet *) pdu->bhs_pkt; - - if ( r2t_sn_send_new != 0 ) { - const uint32_t des_data_xfer_len = r2t_pkt->des_data_xfer_len; - - task->r2t_sn_ack++; - - uint32_t len = (des_data_xfer_len - task->r2t_next_exp_pos); - - if ( len > conn->session->max_burst_len ) - len = conn->session->max_burst_len; - - iscsi_connection_pdu_free( conn, pdu ); - - const int rc = iscsi_r2t_send( conn, task, &task->r2t_sn, task->r2t_next_exp_pos, len, task->target_xfer_tag ); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } else { - iscsi_put_be32( (uint8_t *) &r2t_pkt->stat_sn, conn->stat_sn ); - iscsi_connection_pdu_write( conn, pdu, NULL, NULL ); - } - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Handles an incoming iSCSI header SCSI data out PDU. - * - * This function handles header SCSI data out - * sent by the client.\n - * If a response needs to be sent, this will - * be done as well. - * - * @param[in] conn Pointer to iSCSI connection to handle. May - * NOT be NULL, so take caution. - * @param[in] pdu Pointer to iSCSI client request PDU to handle. - * May be NULL in which case an error is returned. - * @return 0 on success. A negative value indicates - * an error. A positive value a warning. - */ -static int iscsi_connection_pdu_header_handle_scsi_data_out(iscsi_connection *conn, iscsi_pdu *pdu) -{ - if ( conn->session->type == ISCSI_SESSION_TYPE_DISCOVERY ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - if ( pdu->ds_len > ISCSI_DEFAULT_MAX_RECV_DS_LEN ) - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - - iscsi_scsi_data_out_req_packet *scsi_data_out_req_pkt = (iscsi_scsi_data_out_req_packet *) pdu->bhs_pkt; - const uint32_t target_xfer_tag = iscsi_get_be32(scsi_data_out_req_pkt->target_xfer_tag); - - iscsi_task *task = iscsi_task_find( conn, target_xfer_tag ); - - if ( task == NULL ) - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_INVALID_PDU_FIELD ); - - pthread_rwlock_rdlock( &conn->device->luns_rwlock ); - - iscsi_scsi_lun *lun = iscsi_device_find_lun( conn->device, task->lun_id ); - - pthread_rwlock_unlock( &conn->device->luns_rwlock ); - - if ( pdu->ds_len > ISCSI_DEFAULT_MAX_RECV_DS_LEN ) - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - - const uint32_t init_task_tag = iscsi_get_be32(scsi_data_out_req_pkt->init_task_tag); - - if ( task->init_task_tag != init_task_tag ) - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_INVALID_PDU_FIELD ); - - const uint32_t data_sn = iscsi_get_be32(scsi_data_out_req_pkt->data_sn); - - if ( data_sn != task->r2t_data_sn ) { - if ( conn->session->err_recovery_level > 0UL ) { - const int rc = iscsi_r2t_recovery_send( conn, task, task->r2t_sn_ack, 1 ); - - if ( rc == 0 ) - return ISCSI_CONNECT_PDU_READ_OK; - } - - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - } - - const uint32_t buf_offset = iscsi_get_be32(scsi_data_out_req_pkt->buf_offset); - - if ( buf_offset != task->r2t_next_exp_pos ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - const uint32_t xfer_len = task->scsi_task.xfer_len; - - task->r2t_len = pdu->ds_len; - task->r2t_next_exp_pos += pdu->ds_len; - task->r2t_data_sn++; - - if ( task->r2t_len > conn->session->max_burst_len ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - if ( (int8_t) scsi_data_out_req_pkt->opcode < 0 ) - task->r2t_len = 0UL; - - if ( xfer_len == task->r2t_next_exp_pos ) { - task->r2t_sn_ack++; - } else if ( ((int8_t) scsi_data_out_req_pkt->opcode < 0) && (xfer_len > task->r2t_next_exp_pos) ) { - task->r2t_sn_ack++; - - uint32_t len = (xfer_len - task->r2t_next_exp_pos); - - if ( len > conn->session->max_burst_len ) - len = conn->session->max_burst_len; - - const int rc = iscsi_r2t_send( conn, task, &task->r2t_sn, task->r2t_next_exp_pos, len, task->target_xfer_tag ); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - task->r2t_next_exp_pos += len; - } - - if ( lun == NULL ) - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); - - if ( task->scsi_task.buf != NULL ) { - pdu->ds_cmd_data = (iscsi_scsi_ds_cmd_data *) (task->scsi_task.buf + task->len); - pdu->ds_len = ISCSI_DEFAULT_MAX_RECV_DS_LEN; + if ( conn->session->current_text_init_task_tag == 0xFFFFFFFFUL ) { + conn->session->current_text_init_task_tag = init_task_tag; + return ISCSI_CONNECT_PDU_READ_OK; } - - return ISCSI_CONNECT_PDU_READ_OK; + return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); } /** @@ -12130,7 +3383,7 @@ static int iscsi_connection_pdu_header_handle_logout_req(iscsi_connection *conn, if ( (conn->session != NULL) && (conn->session->type == ISCSI_SESSION_TYPE_DISCOVERY) && (logout_req_pkt->reason_code != ISCSI_LOGOUT_REQ_REASON_CODE_CLOSE_SESSION) ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, 0UL, conn->data_digest ); + iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0UL ); if ( response_pdu == NULL ) { logadd( LOG_ERROR, "iscsi_connection_pdu_header_handle_logout_req: Out of memory while allocating iSCSI logout response PDU" ); @@ -12161,8 +3414,7 @@ static int iscsi_connection_pdu_header_handle_logout_req(iscsi_connection *conn, iscsi_put_be32( (uint8_t *) &logout_response_pkt->stat_sn, conn->stat_sn++ ); if ( conn->session != NULL ) { - if ( conn->session->conns == 1UL ) - conn->session->max_cmd_sn++; + conn->session->max_cmd_sn++; iscsi_put_be32( (uint8_t *) &logout_response_pkt->exp_cmd_sn, conn->session->exp_cmd_sn ); iscsi_put_be32( (uint8_t *) &logout_response_pkt->max_cmd_sn, conn->session->max_cmd_sn ); @@ -12176,34 +3428,12 @@ static int iscsi_connection_pdu_header_handle_logout_req(iscsi_connection *conn, logout_response_pkt->time_retain = 0U; logout_response_pkt->reserved5 = 0UL; - iscsi_connection_pdu_write( conn, response_pdu, NULL, NULL ); + iscsi_connection_pdu_write( conn, response_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } /** - * @brief Handles an incoming iSCSI header SNACK request PDU. - * - * This function handles SNACK request header - * data sent by the client.\n - * If a response needs to be sent, this will - * be done as well. - * - * @param[in] conn Pointer to iSCSI connection to handle. May - * NOT be NULL, so take caution. - * @param[in] pdu Pointer to iSCSI client request PDU to handle. - * May be NULL in which case an error is returned. - * @return 0 on success. A negative value indicates - * an error. A positive value a warning. - */ -static int iscsi_connection_pdu_header_handle_snack_req(iscsi_connection *conn, iscsi_pdu *pdu) -{ - // TODO: Implement opcode. - - return 0; -} - -/** * @brief Handles an incoming iSCSI header PDU. * * This function handles all header data sent @@ -12229,16 +3459,17 @@ static int iscsi_connection_pdu_header_handle(iscsi_connection *conn, iscsi_pdu return iscsi_connection_pdu_header_handle_login_req( conn, pdu ); if ( ((conn->flags & ISCSI_CONNECT_FLAGS_FULL_FEATURE) == 0) && (conn->state == ISCSI_CONNECT_STATE_RUNNING) ) { - iscsi_pdu *login_response_pdu = iscsi_connection_pdu_create( conn, 0U, 0, 0UL, 0 ); + iscsi_pdu *login_response_pdu = iscsi_connection_pdu_create( conn, 0UL ); if ( login_response_pdu == NULL ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; iscsi_connection_login_response_reject( login_response_pdu, pdu ); - iscsi_connection_pdu_write( conn, login_response_pdu, NULL, NULL ); + iscsi_connection_pdu_write( conn, login_response_pdu ); return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } else if ( conn->state == ISCSI_CONNECT_STATE_INVALID ) { + } + if ( conn->state == ISCSI_CONNECT_STATE_INVALID ) { return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } @@ -12258,41 +3489,23 @@ static int iscsi_connection_pdu_header_handle(iscsi_connection *conn, iscsi_pdu break; } - case ISCSI_OPCODE_CLIENT_TASK_FUNC_REQ : { - rc = iscsi_connection_pdu_header_handle_task_func_req( conn, pdu ); - - break; - } case ISCSI_OPCODE_CLIENT_TEXT_REQ : { rc = iscsi_connection_pdu_header_handle_text_req( conn, pdu ); break; } - case ISCSI_OPCODE_CLIENT_SCSI_DATA_OUT : { - rc = iscsi_connection_pdu_header_handle_scsi_data_out( conn, pdu ); - - break; - } case ISCSI_OPCODE_CLIENT_LOGOUT_REQ : { rc = iscsi_connection_pdu_header_handle_logout_req( conn, pdu ); break; } - case ISCSI_OPCODE_CLIENT_SNACK_REQ : { - rc = iscsi_connection_pdu_header_handle_snack_req( conn, pdu ); - - break; - } default : { - return iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_PROTOCOL_ERR ); + rc = iscsi_connection_handle_reject( conn, pdu, ISCSI_REJECT_REASON_COMMAND_NOT_SUPPORTED ); break; } } - if ( rc < 0 ) - logadd( LOG_ERROR, "Fatal error during header handler (opcode 0x%02x) detected for device %s", (int) opcode, (conn->device != NULL ? (char *) conn->device->name : "(null)") ); - return rc; } @@ -12316,8 +3529,8 @@ static int iscsi_connection_pdu_data_handle_nop_out(iscsi_connection *conn, iscs iscsi_nop_out_packet *nop_out_pkt = (iscsi_nop_out_packet *) pdu->bhs_pkt; uint32_t ds_len = pdu->ds_len; - if ( ds_len > conn->max_recv_ds_len ) - ds_len = conn->max_recv_ds_len; + if ( ds_len > conn->session->opts.MaxRecvDataSegmentLength ) + ds_len = conn->session->opts.MaxRecvDataSegmentLength; const uint64_t lun = iscsi_get_be64(nop_out_pkt->lun); const uint32_t init_task_tag = iscsi_get_be32(nop_out_pkt->init_task_tag); @@ -12327,7 +3540,7 @@ static int iscsi_connection_pdu_data_handle_nop_out(iscsi_connection *conn, iscs if ( init_task_tag == 0xFFFFFFFFUL ) return ISCSI_CONNECT_PDU_READ_OK; - iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, ds_len, conn->data_digest ); + iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, ds_len ); if ( response_pdu == NULL ) { logadd( LOG_ERROR, "iscsi_connection_pdu_data_handle_nop_out: Out of memory while allocating iSCSI NOP-In response PDU" ); @@ -12342,8 +3555,8 @@ static int iscsi_connection_pdu_data_handle_nop_out(iscsi_connection *conn, iscs nop_in_pkt->reserved = 0U; iscsi_put_be32( (uint8_t *) &nop_in_pkt->total_ahs_len, ds_len ); // TotalAHSLength is always 0 and DataSegmentLength is 24-bit, so write in one step. iscsi_put_be64( (uint8_t *) &nop_in_pkt->lun, lun ); - iscsi_put_be32( (uint8_t *) &nop_in_pkt->init_task_tag, init_task_tag ); nop_in_pkt->target_xfer_tag = 0xFFFFFFFFUL; // Minus one does not require endianess conversion + iscsi_put_be32( (uint8_t *) &nop_in_pkt->init_task_tag, init_task_tag ); iscsi_put_be32( (uint8_t *) &nop_in_pkt->stat_sn, conn->stat_sn++ ); if ( (nop_out_pkt->opcode & ISCSI_OPCODE_FLAGS_IMMEDIATE) == 0 ) @@ -12357,142 +3570,7 @@ static int iscsi_connection_pdu_data_handle_nop_out(iscsi_connection *conn, iscs if ( ds_len != 0UL ) memcpy( response_pdu->ds_cmd_data, pdu->ds_cmd_data, ds_len ); - iscsi_connection_pdu_write( conn, response_pdu, NULL, NULL ); - - // conn->nop_in_last = iscsi_get_ticks(); - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Handles an incoming iSCSI payload data SCSI read command request PDU. - * - * This function handles SCSI read command request - * payload data sent by the client.\n - * If a response needs to be sent, this will - * be done as well. - * - * @param[in] conn Pointer to iSCSI connection to handle. May - * NOT be NULL, so take caution. - * @param[in] task Pointer to iSCSI task associated for reading. - * May be NULL in which case an error is returned. - * @return 0 on success. A negative value indicates - * an error. A positive value a warning. - */ -static int iscsi_connection_pdu_data_handle_scsi_cmd_read(iscsi_connection *conn, iscsi_task *task) -{ - if ( task->scsi_task.xfer_len <= ISCSI_DEFAULT_MAX_RECV_DS_LEN ) { - task->parent = NULL; - task->scsi_task.buf = NULL; - task->scsi_task.pos = 0UL; - task->scsi_task.len = task->scsi_task.xfer_len; - - iscsi_task_queue( conn, task ); - - return ISCSI_CONNECT_PDU_READ_OK; - } - - iscsi_list_create( &task->sub_tasks ); - - task->pos = 0UL; - - iscsi_list_enqueue( &conn->scsi_data_in_queued_tasks, &task->node ); - - return iscsi_connection_handle_scsi_data_in_queued_tasks( conn ); -} - -/** - * @brief Creates and submits a sub task for writing. - * - * This function is also assigns the task with - * an iSCSI PDU. - * - * @param[in] conn Pointer to iSCSI connection which handles - * this task. May NOT be NULL, so be caureful. - * @param[in] task Pointer to iSCSI task which should be the - * parent of the new sub task. NULL if NOT - * allowed here, so take caution. - * @param[in] pdu Pointer to iSCSI PDU which contains - * the desired buffer length to write. NULL - * is a prohibited value here, take caution. - * @param[in] buf Pointer to buffer containing - * the write data and may NOT be NULL, so - * be careful. - * @return 0 on successful sub task submit or a - * negative error code otherwise. - */ -static int iscsi_task_sub_task_submit_write(iscsi_connection *conn, iscsi_task *task, iscsi_pdu *pdu, uint8_t *buf) -{ - iscsi_task *sub_task = iscsi_task_create( conn, task, iscsi_scsi_task_xfer_complete ); - - if ( sub_task == NULL ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - sub_task->scsi_task.buf = buf; - sub_task->scsi_task.pos = task->pos; - sub_task->scsi_task.len = pdu->ds_len; - - pdu->task = sub_task; - pdu->ref++; - - task->pos += pdu->ds_len; - - iscsi_task_queue( conn, sub_task ); - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Handles an incoming iSCSI payload data SCSI write command request PDU. - * - * This function handles SCSI write command - * request payload data sent by the client.\n - * If a response needs to be sent, this will - * be done as well. - * - * @param[in] conn Pointer to iSCSI connection to handle. May - * NOT be NULL, so take caution. - * @param[in] task Pointer to iSCSI task associated for reading. - * May be NULL in which case an error is returned. - * @return 0 on success. A negative value indicates - * an error. A positive value a warning. - */ -static int iscsi_connection_pdu_data_handle_scsi_cmd_write(iscsi_connection *conn, iscsi_task *task) -{ - iscsi_pdu *pdu = task->pdu; - iscsi_scsi_cmd_packet *scsi_cmd_pkt = (iscsi_scsi_cmd_packet *) pdu->bhs_pkt; - const uint32_t xfer_len = task->scsi_task.xfer_len; - - if ( ((scsi_cmd_pkt->flags_task & ISCSI_SCSI_CMD_FLAGS_FINAL) != 0) && (pdu->ds_len < xfer_len) ) { - int rc = iscsi_task_xfer_add( conn, task ); - - if ( rc < 0 ) { - iscsi_task_destroy( task ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - if ( pdu->ds_len != 0UL ) { - rc = iscsi_task_sub_task_submit_write( conn, task, pdu, (uint8_t *) pdu->ds_cmd_data ); - - if ( rc < 0 ) { - iscsi_task_destroy( task ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - } - - return ISCSI_CONNECT_PDU_READ_OK; - } - - if ( pdu->ds_len == xfer_len ) { - iscsi_scsi_task *scsi_task = &task->scsi_task; - - scsi_task->buf = (uint8_t *) pdu->ds_cmd_data; - scsi_task->len = xfer_len; - } - - iscsi_task_queue( conn, task ); + iscsi_connection_pdu_write( conn, response_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } @@ -12519,212 +3597,22 @@ static int iscsi_connection_pdu_data_handle_scsi_cmd(iscsi_connection *conn, isc if ( task == NULL ) return ISCSI_CONNECT_PDU_READ_OK; - pthread_rwlock_rdlock( &conn->device->luns_rwlock ); - - if ( iscsi_device_find_lun( conn->device, task->lun_id ) == NULL ) { - pthread_rwlock_unlock( &conn->device->luns_rwlock ); + if ( task->lun_id != ISCSI_DEFAULT_LUN ) { + logadd( LOG_WARNING, "Received SCSI command for unknown LUN %d", task->lun_id ); iscsi_scsi_task_lun_process_none( &task->scsi_task ); - iscsi_scsi_task_xfer_complete( &task->scsi_task ); + iscsi_scsi_task_xfer_complete( &task->scsi_task, pdu ); return ISCSI_CONNECT_PDU_READ_OK; } - pthread_rwlock_unlock( &conn->device->luns_rwlock ); - if ( (task->scsi_task.flags & ISCSI_SCSI_TASK_FLAGS_XFER_READ) != 0 ) { - return iscsi_connection_pdu_data_handle_scsi_cmd_read( conn, task ); - } else if ( (task->scsi_task.flags & ISCSI_SCSI_TASK_FLAGS_XFER_WRITE) != 0 ) { - return iscsi_connection_pdu_data_handle_scsi_cmd_write( conn, task ); - } else if ( (task->scsi_task.flags & (ISCSI_SCSI_TASK_FLAGS_XFER_READ | ISCSI_SCSI_TASK_FLAGS_XFER_WRITE)) == 0 ) { - iscsi_task_queue( conn, task ); - - return ISCSI_CONNECT_PDU_READ_OK; - } - - pdu->task = NULL; - iscsi_task_destroy( task ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; -} - -/** - * @brief Negotiates connection authentication method (none or CHAP). - * - * This function updates the key and value pairs if, and only if - * CHAP is either disabled or required. - * - * @param[in] conn Pointer to iSCSI connection to update the key - * and value pairs for. May NOT be NULL, so be careful. - * @return 0 on successful update, a negative error code otherwise. - */ -static int iscsi_connection_chap_negotiate(iscsi_connection *conn) -{ - int rc = 0; - - if ( (conn->flags & ISCSI_CONNECT_FLAGS_CHAP_DISABLE) != 0 ) - rc = iscsi_update_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD, (uint8_t *) "None" ); - else if ( (conn->flags & ISCSI_CONNECT_FLAGS_CHAP_REQUIRE) != 0 ) - rc = iscsi_update_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD, (uint8_t *) "CHAP" ); - - return rc; -} - -/** - * @brief Discovers iSCSI CHAP authentication session. - * - * This function copies over the global CHAP configuration - * into the iSCSI connection structure and then negotiates. - * - * @param[in] conn Pointer to iSCSI connection for iSCSI - * CHAP authentication discovery. May NOT be - * NULL, so be careful. - * @return 0 on successful negotiation, a negative error - * code otherwise. - */ -static int iscsi_connection_login_session_chap_discovery(iscsi_connection *conn) -{ - conn->flags &= ~(ISCSI_CONNECT_FLAGS_CHAP_DISABLE | ISCSI_CONNECT_FLAGS_CHAP_REQUIRE | ISCSI_CONNECT_FLAGS_CHAP_MUTUAL); - - if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_CHAP_DISABLE) != 0 ) - conn->flags |= ISCSI_CONNECT_FLAGS_CHAP_DISABLE; - - if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_CHAP_REQUIRE) != 0 ) - conn->flags |= ISCSI_CONNECT_FLAGS_CHAP_REQUIRE; - - if ( (iscsi_globvec->flags & ISCSI_GLOBALS_FLAGS_CHAP_MUTUAL) != 0 ) - conn->flags |= ISCSI_CONNECT_FLAGS_CHAP_MUTUAL; - - conn->chap_group = iscsi_globvec->chap_group; - - return iscsi_connection_chap_negotiate( conn ); -} - -/** - * @brief Negotiates CHAP authentication. - * - * This function updates the key and value pairs if, and only if - * CHAP authentication is either disabled or required in the - * target node. - * - * @param[in] conn Pointer to iSCSI connection to update the key - * and value pairs for. May NOT be NULL, so be careful. - * @param[in] target Pointer to iSCSI target node used to check - * the CHAP authentication. NULL is not allowed here, - * so take caution. - * @return 0 on successful update, a negative error code otherwise. - */ -static int iscsi_connection_login_chap_negotiate(iscsi_connection *conn, const iscsi_target_node *target) -{ - conn->flags &= ~(ISCSI_CONNECT_FLAGS_CHAP_DISABLE | ISCSI_CONNECT_FLAGS_CHAP_REQUIRE | ISCSI_CONNECT_FLAGS_CHAP_MUTUAL); - - if ( (target->flags & ISCSI_TARGET_NODE_FLAGS_CHAP_DISABLE) != 0 ) - conn->flags |= ISCSI_CONNECT_FLAGS_CHAP_DISABLE; - - if ( (target->flags & ISCSI_TARGET_NODE_FLAGS_CHAP_REQUIRE) != 0 ) - conn->flags |= ISCSI_CONNECT_FLAGS_CHAP_REQUIRE; - - if ( (target->flags & ISCSI_TARGET_NODE_FLAGS_CHAP_MUTUAL) != 0 ) - conn->flags |= ISCSI_CONNECT_FLAGS_CHAP_MUTUAL; - - conn->chap_group = target->chap_group; - - return iscsi_connection_chap_negotiate( conn ); -} - -/** - * @brief Negotiates connection header and data digest (CRC32C). - * - * This function updates the key and value pairs if, and only if - * header and data digests are enabled in the target node. - * - * @param[in] conn Pointer to iSCSI connection to update the key - * and value pairs for. May NOT be NULL, so be careful. - * @param[in] target Pointer to iSCSI target node used to check - * the digest status. NULL is not allowed here, so take - * caution. - * @return 0 on successful update, a negative error code otherwise. - */ -static int iscsi_connection_login_digest_negotiate(iscsi_connection *conn, const iscsi_target_node *target) -{ - int rc = 0; - - if ( target->header_digest != 0 ) - rc = iscsi_update_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_HEADER_DIGEST, (uint8_t *) "CRC32C" ); - - if ( target->data_digest != 0 ) - rc = iscsi_update_key_value_pair( conn->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_DIGEST, (uint8_t *) "CRC32C" ); - - return rc; -} - -/** - * @brief Determines iSCSI session login steps for normal authentication. - * - * This function also does related validation checks. - * - * @param[in] conn Pointer to iSCSI connection, may NOT be - * NULL, so take caution. - * @param[in] login_response_pdu Pointer to login response PDU where - * NULL is not allowed, so be careful. - * @param[in] key_value_pairs Pointer to hash map containing the login - * request key and value pairs and may NOT be NULL, so - * take caution. - * @param[in] init_port_name Pointer to iSCSI initiator port name. NULL - * is NOT an allowed value, so be careful. - * @param[in] cid Connection ID (CID). - * @return 0 on successful operation, a negative error code - * otherwise. - */ -static int iscsi_connection_login_session_normal(iscsi_connection *conn, iscsi_pdu *login_response_pdu, iscsi_hashmap *key_value_pairs, uint8_t *init_port_name, const uint cid) -{ - iscsi_target_node *target = NULL; - uint8_t *target_name; - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - int rc = iscsi_get_key_value_pair( key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_NAME, &target_name ); - - if ( (rc < 0) || (target_name == NULL) ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISSING_PARAMETER; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - - const uint8_t *target_name_short = (uint8_t *) strstr( (char *) target_name, ":" ); - - conn->target_name_short = iscsi_sprintf_alloc( "%s", ((target_name_short != NULL) ? ++target_name_short : target_name) ); - - if ( conn->target_name_short == NULL ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - rc = iscsi_connection_login_check_target( conn, login_response_pdu, target_name, &target ); - - if ( rc < 0 ) - return rc; - - conn->device = target->device; - conn->target = target; - conn->target_port = iscsi_device_find_port_by_portal_group_tag( target->device, conn->pg_tag ); - - rc = iscsi_connection_login_check_session( conn, login_response_pdu, init_port_name, cid ); - - if ( rc < 0 ) - return rc; - - rc = iscsi_connection_login_chap_negotiate( conn, target ); - - if ( rc == 0 ) - rc = iscsi_connection_login_digest_negotiate( conn, target ); - - if (rc != 0) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_INVALID_LOGIN_REQ_TYPE; + task->scsi_task.buf = NULL; + task->scsi_task.pos = 0UL; + task->scsi_task.len = task->scsi_task.xfer_len; } + iscsi_scsi_lun_task_run( &task->scsi_task, pdu ); - return rc; + return ISCSI_CONNECT_PDU_READ_OK; } /* @@ -12733,174 +3621,26 @@ static int iscsi_connection_login_session_normal(iscsi_connection *conn, iscsi_p * 0: success * otherwise: error */ -static int iscsi_connection_login_set_info(iscsi_connection *conn, iscsi_pdu *login_response_pdu, const uint8_t *init_port_name, const int type, const uint cid) +static int iscsi_connection_login_set_info(iscsi_connection *conn, iscsi_pdu *login_response_pdu, const int type, const uint cid) { conn->flags &= ~ISCSI_CONNECT_FLAGS_AUTH; - conn->auth_chap.phase = ISCSI_AUTH_CHAP_PHASE_WAIT_A; conn->cid = (uint16_t) cid; if ( conn->session == NULL ) { iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - iscsi_target_node *target = conn->target; - const uint64_t isid = iscsi_connection_get_isid( &login_response_pkt->isid ); - iscsi_port *init_port = iscsi_port_create( init_port_name, isid, 0U ); - - if ( init_port == NULL ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - - conn->session = iscsi_session_create( conn, target, type ); + conn->session = iscsi_session_create( conn, type ); if ( conn->session == NULL ) { - iscsi_port_destroy( init_port ); - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; } - conn->session->init_port = init_port; conn->stat_sn = iscsi_get_be32(login_response_pkt->stat_sn); - conn->session->isid = isid; - - pthread_rwlock_wrlock( &iscsi_globvec->sessions_rwlock ); - iscsi_hashmap_key_create_id( iscsi_globvec->sessions, &conn->session->tsih ); - - int rc = iscsi_hashmap_put( iscsi_globvec->sessions, (uint8_t *) &conn->session->tsih, sizeof(conn->session->tsih), (uint8_t *) conn->session ); - - pthread_rwlock_unlock( &iscsi_globvec->sessions_rwlock ); - - if ( rc < 0 ) { - iscsi_session_destroy( conn->session ); - conn->session = NULL; - - iscsi_port_destroy( init_port ); - - return rc; - } - rc = iscsi_port_transport_id_set( conn->session->init_port, conn->init_name, isid ); - - if ( rc < 0 ) { - iscsi_session_destroy( conn->session ); - conn->session = NULL; - - iscsi_port_destroy( init_port ); - - return rc; - } - - conn->session->queue_depth = ((target != NULL) ? target->queue_depth : 1U); conn->session->exp_cmd_sn = login_response_pdu->cmd_sn; - conn->session->max_cmd_sn = (uint32_t) (login_response_pdu->cmd_sn + (uint32_t) conn->session->queue_depth - 1UL); - } - - conn->init_port = conn->session->init_port; - - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Sets iSCSI session target info key and value pairs. - * - * This function also sets the login response PDU - * key and value pairs. - * - * @param[in] conn Pointer to iSCSI connection of which - * the target info should be set, may NOT be NULL, - * so take caution. - * @param[in] login_response_pdu Pointer to login response PDU and - * NULL is not allowed here, so be careful. - * @param[in] type iSCSI session type. - * @return 0 on successfully setting target info, a - * negative error code otherwise. - */ -static int iscsi_connection_login_set_target_info(iscsi_connection *conn, iscsi_pdu *login_response_pdu, const int type) -{ - iscsi_target_node *target = conn->target; - int rc; - - if ( target != NULL ) { - rc = iscsi_update_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ALIAS, ((target->alias != NULL) ? target->alias : (uint8_t *) "") ); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER; - } - - uint8_t *tmp_buf = iscsi_sprintf_alloc( "%s:%s,%" PRIu64, conn->portal_host, conn->portal_port, conn->pg_tag ); - - if ( tmp_buf == NULL ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - rc = iscsi_update_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS, tmp_buf ); - - free( tmp_buf ); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER; - - rc = iscsi_update_int_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_PORTAL_GROUP_TAG, (int32_t) conn->pg_tag ); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER; - - if ( target != NULL ) { - rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ALIAS, &tmp_buf ); - - if ( (rc == 0) && (strlen( (char *) tmp_buf ) != 0) ) { - iscsi_key_value_pair *key_value_pair; - rc = iscsi_hashmap_get( iscsi_globvec->session_key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ALIAS, strlen( (char *) ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ALIAS ) + 1, (uint8_t **) &key_value_pair); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - const int32_t ds_len = iscsi_append_key_value_pair_packet( key_value_pair, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ALIAS, tmp_buf, (uint8_t *) login_response_pdu->ds_cmd_data, login_response_pdu->ds_len, login_response_pdu->len ); - - if ( ds_len < 0L ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - login_response_pdu->len = ds_len; - } - - if ( type == ISCSI_SESSION_TYPE_DISCOVERY ) { - rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS, &tmp_buf ); - - if ( (rc == 0) && (strlen( (char *) tmp_buf ) != 0) ) { - iscsi_key_value_pair *key_value_pair; - rc = iscsi_hashmap_get( iscsi_globvec->session_key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS, strlen( (char *) ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS ) + 1, (uint8_t **) &key_value_pair); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - const int32_t ds_len = iscsi_append_key_value_pair_packet( key_value_pair, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS, tmp_buf, (uint8_t *) login_response_pdu->ds_cmd_data, login_response_pdu->ds_len, login_response_pdu->len ); - - if ( ds_len < 0L ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - login_response_pdu->ds_len = ds_len; - } - } - - rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_PORTAL_GROUP_TAG, &tmp_buf ); - - if ( rc == 0 ) { - iscsi_key_value_pair *key_value_pair; - rc = iscsi_hashmap_get( iscsi_globvec->session_key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_PORTAL_GROUP_TAG, strlen( (char *) ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_PORTAL_GROUP_TAG ) + 1, (uint8_t **) &key_value_pair); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - const int32_t ds_len = iscsi_append_key_value_pair_packet( key_value_pair, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_PORTAL_GROUP_TAG, tmp_buf, (uint8_t *) login_response_pdu->ds_cmd_data, login_response_pdu->ds_len, login_response_pdu->len ); - - if ( ds_len < 0L ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - - login_response_pdu->ds_len = ds_len; - } + conn->session->max_cmd_sn = (uint32_t) (login_response_pdu->cmd_sn + ISCSI_DEFAULT_QUEUE_DEPTH - 1UL); } return ISCSI_CONNECT_PDU_READ_OK; @@ -12916,218 +3656,135 @@ static int iscsi_connection_login_set_target_info(iscsi_connection *conn, iscsi_ * may NOT be NULL, so be careful. * @param[in] login_response_pdu Pointer to login response PDU. * NULL is not allowed here, so take caution. - * @param[in] key_value_pairs Pointer to key and value pairs. + * @param[in] kvpairs Pointer to key and value pairs. * which may NOT be NULL, so take caution. * @param[in] cid Connection ID (CID). * @return 0 on success, a negative error code otherwise. */ -static int iscsi_connection_handle_login_phase_none(iscsi_connection *conn, iscsi_pdu *login_response_pdu, iscsi_hashmap *key_value_pairs, uint cid) +static int iscsi_connection_handle_login_phase_none(iscsi_connection *conn, iscsi_pdu *login_response_pdu, iscsi_negotiation_kvp *kvpairs, uint cid) { - uint8_t *init_port_name = NULL; + int type, rc; iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - conn->device = NULL; - conn->target = NULL; - - int rc = iscsi_connection_login_init_port( conn, login_response_pdu, key_value_pairs, &init_port_name ); - - if ( rc < 0 ) { - if ( init_port_name != NULL ) - free( init_port_name ); - - return rc; - } - - int type; - - rc = iscsi_connection_login_session_type( login_response_pdu, key_value_pairs, &type ); - - if ( rc < 0 ) { - free( init_port_name ); + rc = iscsi_login_parse_session_type( login_response_pdu, kvpairs->SessionType, &type ); + if ( rc < 0 ) return rc; - } - if ( type == ISCSI_SESSION_TYPE_NORMAL ) { - rc = iscsi_connection_login_session_normal( conn, login_response_pdu, key_value_pairs, init_port_name, cid ); - } else if ( type == ISCSI_SESSION_TYPE_DISCOVERY ) { - login_response_pkt->tsih = 0U; - - rc = iscsi_connection_login_session_chap_discovery( conn ); + if ( kvpairs->TargetName != NULL && type == ISCSI_SESSION_TYPE_NORMAL ) { + rc = iscsi_image_from_target( conn, login_response_pdu, kvpairs->TargetName ); } else { login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISSING_PARAMETER; - rc = ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - - if ( rc < 0 ) { - free( init_port_name ); - - return rc; + return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; } - rc = iscsi_connection_login_set_info( conn, login_response_pdu, init_port_name, type, cid ); - - free( init_port_name ); - if ( rc < 0 ) return rc; - if ( type == ISCSI_SESSION_TYPE_DISCOVERY ) { - conn->session->max_conns = 1UL; - - rc = iscsi_add_int_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_CONNECTIONS, conn->session->max_conns ); - - if ( rc < 0 ) - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER; + return iscsi_connection_login_set_info( conn, login_response_pdu, type, cid ); +} + +static int iscsi_write_login_options_to_pdu( iscsi_connection *conn, iscsi_negotiation_kvp *pairs, iscsi_pdu *response_pdu ) +{ + uint payload_len = response_pdu->ds_write_pos; + +# define ADD_KV_INTERNAL(num, key, value) do { \ +int rc = iscsi_append_key_value_pair_packet( num, key, value, (char *)response_pdu->ds_cmd_data, payload_len, response_pdu->ds_len ); \ +if ( rc < 0 ) return -1; \ +payload_len += rc; \ +} while (0) +# define ADD_KV_OPTION_INT(key) do { \ +if ( pairs->key != -1 ) ADD_KV_INTERNAL( true, #key, (const char *)(size_t)conn->session->opts.key ); \ +} while (0) +# define ADD_KV_OPTION_STR(key) do { \ +if ( pairs->key != NULL ) ADD_KV_INTERNAL( false, #key, conn->session->opts.key ); \ +} while (0) +# define ADD_KV_PLAIN_INT(key, value) do { \ +if ( pairs->key != -1 ) ADD_KV_INTERNAL( true, #key, (const char *)(size_t)(value) ); \ +} while (0) +# define ADD_KV_PLAIN_STR(key, value) do { \ +if ( pairs->key != NULL ) ADD_KV_INTERNAL( false, #key, value ); \ +} while (0) + ADD_KV_OPTION_INT( MaxRecvDataSegmentLength ); + ADD_KV_OPTION_INT( MaxBurstLength ); + ADD_KV_OPTION_INT( FirstBurstLength ); + ADD_KV_PLAIN_INT( MaxConnections, 1 ); + ADD_KV_PLAIN_INT( ErrorRecoveryLevel, 0 ); + ADD_KV_PLAIN_STR( HeaderDigest, "None" ); + ADD_KV_PLAIN_STR( DataDigest, "None" ); +# undef ADD_KV_PLAIN +# undef ADD_KV_OPTION_INT +# undef ADD_KV_OPTION_STR + + if ( payload_len <= response_pdu->ds_len ) { + response_pdu->ds_write_pos = payload_len; + } else { + response_pdu->ds_write_pos = response_pdu->ds_len; } - - return iscsi_connection_login_set_target_info( conn, login_response_pdu, type ); + return (int)payload_len; } /** - * @brief Handles the Current Stage (CSG) bit of login response. + * @brief Handles iSCSI connection login response. * - * This function determines the authentication method - * and processes the various authentication stages. + * This function negotiates the login parameters + * and determines the authentication method. * - * @param[in] conn Pointer to iSCSI connection, may NOT be - * NULL, so take caution. + * @param[in] conn Pointer to iSCSI connection, + * may NOT be NULL, so be careful. * @param[in] login_response_pdu Pointer to login response PDU. - * NULL is NOT an allowed value here, so be careful. - * @param[in] key_value_pairs Pointer to key and value pairs to - * retrieve authentication details from. This - * is NOT allowed to be NULL. Be careful! - * @return 0 if authentication has been handled successfully, - * a negative error code otherwise. + * NULL is not allowed here, so take caution. + * @return 0 on success, a negative error code otherwise. */ -static int iscsi_connecction_handle_login_response_csg_bit(iscsi_connection *conn, iscsi_pdu *login_response_pdu, iscsi_hashmap *key_value_pairs) +static int iscsi_connecction_handle_login_response(iscsi_connection *conn, iscsi_pdu *login_response_pdu, iscsi_negotiation_kvp *pairs) { iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; + iscsi_connection_update_key_value_pairs( conn, pairs ); + int payload_len = iscsi_write_login_options_to_pdu( conn, pairs, login_response_pdu ); - switch ( ISCSI_LOGIN_RESPONSE_FLAGS_GET_CURRENT_STAGE(login_response_pkt->flags) ) { - case ISCSI_LOGIN_RESPONSE_FLAGS_CURRENT_STAGE_SECURITY_NEGOTIATION : { - uint8_t *auth_method; - const int rc = iscsi_get_key_value_pair( key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD, (uint8_t **) &auth_method ); - - if ( rc < 0 ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISSING_PARAMETER; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - - if ( strcasecmp( (char *) auth_method, "None" ) == 0 ) { - conn->flags |= ISCSI_CONNECT_FLAGS_AUTH; - } else { - const int32_t ds_len = iscsi_connection_auth_key_value_pairs( conn, key_value_pairs, auth_method, (uint8_t *) login_response_pdu->ds_cmd_data, login_response_pdu->ds_len, login_response_pdu->len ); - - if ( ds_len < 0L ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_AUTH_ERR; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - - login_response_pdu->ds_len = ds_len; - - if ( (conn->flags & ISCSI_CONNECT_FLAGS_AUTH) == 0 ) - login_response_pkt->flags &= (int8_t) ~ISCSI_LOGIN_RESPONSE_FLAGS_TRANSIT; - } - - break; - } - case ISCSI_LOGIN_RESPONSE_FLAGS_CURRENT_STAGE_LOGIN_OPERATIONAL_NEGOTIATION : { - if ( conn->state == ISCSI_CONNECT_STATE_INVALID ) { - if ( conn->flags & ISCSI_CONNECT_FLAGS_CHAP_REQUIRE ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_AUTH_ERR; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } else { - conn->flags |= ISCSI_CONNECT_FLAGS_AUTH; - } - } - - if ( (conn->flags & ISCSI_CONNECT_FLAGS_AUTH) == 0 ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_AUTH_ERR; + if ( payload_len < 0 || payload_len > login_response_pdu->ds_len ) { + login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_SERVER_ERR; + login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_SERVER_ERR_OUT_OF_RESOURCES; - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } + return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; + } - break; - } - case ISCSI_LOGIN_RESPONSE_FLAGS_CURRENT_STAGE_FULL_FEATURE_PHASE : { + // Handle current stage (CSG bits) + switch ( ISCSI_LOGIN_RESPONSE_FLAGS_GET_CURRENT_STAGE(login_response_pkt->flags) ) { + case ISCSI_LOGIN_RESPONSE_FLAGS_CURRENT_STAGE_SECURITY_NEGOTIATION : { + if ( pairs->AuthMethod != NULL && strcasecmp( pairs->AuthMethod, "None" ) == 0 ) { + conn->flags |= ISCSI_CONNECT_FLAGS_AUTH; + } else { + // Only "None" supported login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISC; + login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_AUTH_ERR; return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - - break; } - default : { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISC; - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - - break; - } + break; } + case ISCSI_LOGIN_RESPONSE_FLAGS_CURRENT_STAGE_LOGIN_OPERATIONAL_NEGOTIATION : { + if ( conn->state == ISCSI_CONNECT_STATE_INVALID ) { + conn->flags |= ISCSI_CONNECT_FLAGS_AUTH; + } - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * - * @brief Checks whether the session type is valid. - * - * This function also can be used to output - * debugging info about the session, which - * is currently not implemented. - * - * @param[in] conn Pointer to iSCSI connection to be checked for - * validity. May NOT be NULL, so be careful. - * @param[in] login_response_pdu Pointer to login response PDU to - * set status class and detail in case of an error. - * NULL is not an allowed value here, take caution. - * @return 0 if the session type is valid, a negative error code - * otherwise. - */ -static int iscsi_connection_login_session_info_notify(iscsi_connection *conn, iscsi_pdu *login_response_pdu) -{ - if ( (conn->session->type != ISCSI_SESSION_TYPE_NORMAL) && (conn->session->type != ISCSI_SESSION_TYPE_DISCOVERY) ) { - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - + break; + } + case ISCSI_LOGIN_RESPONSE_FLAGS_CURRENT_STAGE_FULL_FEATURE_PHASE : + default : { login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISC; return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; } + } - return ISCSI_CONNECT_PDU_READ_OK; -} - -/** - * @brief Handles the Transit (T) bit of login response. - * - * This function handles the transitional stages - * of the authentication process. - * - * @param[in] conn Pointer to iSCSI connection, may NOT be - * NULL, so take caution. - * @param[in] login_response_pdu Pointer to login response PDU. - * NULL is NOT an allowed value here, so be careful. - * @return 0 if transition has been handled successfully, - * a negative error code otherwise. - */ -static int iscsi_connecction_handle_login_response_t_bit(iscsi_connection *conn, iscsi_pdu *login_response_pdu) -{ - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - - switch ( ISCSI_LOGIN_RESPONSE_FLAGS_GET_NEXT_STAGE(login_response_pkt->flags) ) { + if ( (login_response_pkt->flags & ISCSI_LOGIN_RESPONSE_FLAGS_TRANSIT) != 0 ) { + // Client set the transition bit - requests to move on to next stage + switch ( ISCSI_LOGIN_RESPONSE_FLAGS_GET_NEXT_STAGE(login_response_pkt->flags) ) { case ISCSI_LOGIN_RESPONSE_FLAGS_NEXT_STAGE_SECURITY_NEGOTIATION : { conn->login_phase = ISCSI_LOGIN_RESPONSE_FLAGS_NEXT_STAGE_SECURITY_NEGOTIATION; @@ -13143,10 +3800,15 @@ static int iscsi_connecction_handle_login_response_t_bit(iscsi_connection *conn, iscsi_put_be16( (uint8_t *) &login_response_pkt->tsih, (uint16_t) conn->session->tsih ); - const int rc = iscsi_connection_login_session_info_notify( conn, login_response_pdu ); + if ( (conn->session->type != ISCSI_SESSION_TYPE_NORMAL) && (conn->session->type != ISCSI_SESSION_TYPE_DISCOVERY) ) { + logadd( LOG_DEBUG1, "Unsupported session type %d, rejecting", conn->session->type ); + iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - if ( rc < 0 ) - return rc; + login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; + login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISC; + + return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; + } conn->flags |= ISCSI_CONNECT_FLAGS_FULL_FEATURE; @@ -13157,8 +3819,7 @@ static int iscsi_connecction_handle_login_response_t_bit(iscsi_connection *conn, login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_MISC; return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - - break; + } } } @@ -13166,45 +3827,6 @@ static int iscsi_connecction_handle_login_response_t_bit(iscsi_connection *conn, } /** - * @brief Handles iSCSI connection login response. - * - * This function negotiates the login parameters - * and determines the authentication method. - * - * @param[in] conn Pointer to iSCSI connection, - * may NOT be NULL, so be careful. - * @param[in] login_response_pdu Pointer to login response PDU. - * NULL is not allowed here, so take caution. - * @param[in] key_value_pairs Pointer to key and value pairs. - * which may NOT be NULL, so take caution. - * @return 0 on success, a negative error code otherwise. - */ -static int iscsi_connecction_handle_login_response(iscsi_connection *conn, iscsi_pdu *login_response_pdu, iscsi_hashmap *key_value_pairs) -{ - iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; - const int32_t ds_len = iscsi_negotiate_key_value_pairs( conn, key_value_pairs, (uint8_t *) login_response_pdu->ds_cmd_data, login_response_pdu->ds_len, login_response_pdu->len ); - - if ( ds_len < 0L ) { - login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; - login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_AUTH_ERR; - - return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; - } - - login_response_pdu->ds_len = (uint32_t) ds_len; - - int rc = iscsi_connecction_handle_login_response_csg_bit( conn, login_response_pdu, key_value_pairs ); - - if ( rc < 0 ) - return rc; - - if ( (login_response_pkt->flags & ISCSI_LOGIN_RESPONSE_FLAGS_TRANSIT) != 0 ) - rc = iscsi_connecction_handle_login_response_t_bit( conn, login_response_pdu ); - - return rc; -} - -/** * @brief Handles an incoming iSCSI payload data login request PDU. * * This function handles login request payload @@ -13221,69 +3843,48 @@ static int iscsi_connecction_handle_login_response(iscsi_connection *conn, iscsi */ static int iscsi_connection_pdu_data_handle_login_req(iscsi_connection *conn, iscsi_pdu *pdu) { + int rc; iscsi_pdu *login_response_pdu = (iscsi_pdu *) conn->login_response_pdu; if ( login_response_pdu == NULL ) return ISCSI_CONNECT_PDU_READ_OK; - iscsi_hashmap *key_value_pairs = iscsi_hashmap_create( (((sizeof(iscsi_session_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1) + ((sizeof(iscsi_connection_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1)) ); - - if ( key_value_pairs == NULL ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - iscsi_login_req_packet *login_req_pkt = (iscsi_login_req_packet *) pdu->bhs_pkt; uint cid = iscsi_get_be16(login_req_pkt->cid); - int rc = iscsi_connection_save_incoming_key_value_pairs( conn, key_value_pairs, login_response_pdu, pdu ); - if ( rc < 0 ) { - iscsi_connection_pdu_login_response( conn, login_response_pdu, NULL, iscsi_connection_pdu_login_err_complete ); + iscsi_negotiation_kvp pairs; + iscsi_login_response_packet *login_response_pkt = (iscsi_login_response_packet *) login_response_pdu->bhs_pkt; + rc = iscsi_parse_login_key_value_pairs( &pairs, (uint8_t *) pdu->ds_cmd_data, pdu->ds_len ); - return ISCSI_CONNECT_PDU_READ_OK; + if ( rc < 0 || rc > login_response_pdu->ds_len ) { + login_response_pkt->status_class = ISCSI_LOGIN_RESPONSE_STATUS_CLASS_CLIENT_ERR; + login_response_pkt->status_detail = ISCSI_LOGIN_RESPONSE_STATUS_DETAILS_CLIENT_ERR_AUTH_ERR; + + return ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE; } if ( conn->state == ISCSI_CONNECT_STATE_INVALID ) { - rc = iscsi_connection_handle_login_phase_none( conn, login_response_pdu, key_value_pairs, cid ); + rc = iscsi_connection_handle_login_phase_none( conn, login_response_pdu, &pairs, cid ); if ( (rc == ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE) || (rc == ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER) ) { - iscsi_connection_pdu_login_response( conn, login_response_pdu, key_value_pairs, iscsi_connection_pdu_login_err_complete ); + iscsi_connection_pdu_login_response( conn, login_response_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } } - rc = iscsi_connecction_handle_login_response( conn, login_response_pdu, key_value_pairs ); - - if ( rc == ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE ) { - iscsi_connection_pdu_login_response( conn, login_response_pdu, key_value_pairs, iscsi_connection_pdu_login_err_complete ); + rc = iscsi_connecction_handle_login_response( conn, login_response_pdu, &pairs ); - return ISCSI_CONNECT_PDU_READ_OK; + if ( rc == ISCSI_CONNECT_PDU_READ_OK ) { + conn->state = ISCSI_CONNECT_STATE_RUNNING; } - conn->state = ISCSI_CONNECT_STATE_RUNNING; - - iscsi_connection_pdu_login_response( conn, login_response_pdu, key_value_pairs, iscsi_connection_pdu_login_ok_complete ); + iscsi_connection_pdu_login_response( conn, login_response_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } /** - * @brief Callback function after text response has been sent. - * - * This function is invoked after the text - * response has been sent to the client via - * TCP/IP. - * - * @param[in] user_data Pointer to iSCSI connection which - * was used for sending the response. - */ -static void iscsi_connection_pdu_text_complete(uint8_t *user_data) -{ - iscsi_connection *conn = (iscsi_connection *) user_data; - - iscsi_connection_update_key_value_pairs( conn ); -} - -/** * @brief Handles an incoming iSCSI payload data text request PDU. * * This function handles text request payload @@ -13300,132 +3901,40 @@ static void iscsi_connection_pdu_text_complete(uint8_t *user_data) */ static int iscsi_connection_pdu_data_handle_text_req(iscsi_connection *conn, iscsi_pdu *pdu) { - iscsi_hashmap *key_value_pairs = iscsi_hashmap_create( (((sizeof(iscsi_session_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1) + ((sizeof(iscsi_connection_key_value_pair_lut) / sizeof(struct iscsi_key_value_pair_lut_entry)) - 1)) ); - - if ( key_value_pairs == NULL ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - iscsi_text_req_packet *text_req_pkt = (iscsi_text_req_packet *) pdu->bhs_pkt; - int rc = iscsi_parse_key_value_pairs( key_value_pairs, (uint8_t *) pdu->ds_cmd_data, pdu->ds_len, ((text_req_pkt->flags & ISCSI_TEXT_REQ_FLAGS_CONTINUE) != 0), &conn->text_partial_pairs ); + iscsi_negotiation_kvp pairs; + int rc = iscsi_parse_login_key_value_pairs( &pairs, (uint8_t *) pdu->ds_cmd_data, pdu->ds_len ); if ( rc < 0 ) { - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } - if ( (pdu->ds_len == 0UL) && (iscsi_hashmap_size( key_value_pairs ) == 0U) ) { - iscsi_hashmap *tmp_hashmap = key_value_pairs; - key_value_pairs = conn->text_key_value_pairs; - conn->text_key_value_pairs = tmp_hashmap; - } - - iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, conn->max_recv_ds_len, conn->data_digest ); + iscsi_pdu *response_pdu = iscsi_connection_pdu_create( conn, 8192 ); if ( response_pdu == NULL ) { logadd( LOG_ERROR, "iscsi_connection_pdu_data_handle_text_req: Out of memory while allocating iSCSI text response PDU" ); - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } - response_pdu->ds_len = 0UL; + iscsi_connection_update_key_value_pairs( conn, &pairs ); - int32_t ds_len = iscsi_negotiate_key_value_pairs( conn, key_value_pairs, (uint8_t *) response_pdu->ds_cmd_data, response_pdu->ds_len, response_pdu->len ); + int payload_len = iscsi_write_login_options_to_pdu( conn, &pairs, response_pdu ); - if ( ds_len < 0L ) { - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); + if ( payload_len < 0 || payload_len > response_pdu->ds_len ) { iscsi_connection_pdu_destroy( response_pdu ); return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } - iscsi_text_response_packet *text_response_pkt = (iscsi_text_response_packet *) response_pdu->bhs_pkt; + iscsi_text_response_packet *text_response_pkt = (iscsi_text_response_packet *) iscsi_connection_pdu_resize( response_pdu, 0, response_pdu->ds_write_pos ); text_response_pkt->opcode = ISCSI_OPCODE_SERVER_TEXT_RES; - text_response_pkt->flags = 0; - - if ( (text_req_pkt->flags & ISCSI_TEXT_REQ_FLAGS_CONTINUE) != 0 ) - text_response_pkt->flags |= (int8_t) ISCSI_TEXT_RESPONSE_FLAGS_CONTINUE; + text_response_pkt->flags = (int8_t) ISCSI_TEXT_RESPONSE_FLAGS_FINAL; - if ( (text_req_pkt->flags & ISCSI_TEXT_REQ_FLAGS_FINAL) != 0 ) - text_response_pkt->flags |= (int8_t) ISCSI_TEXT_RESPONSE_FLAGS_FINAL; - - text_req_pkt->reserved = 0U; - - uint8_t *send_targets_val; - rc = iscsi_get_key_value_pair( key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_SEND_TARGETS, &send_targets_val ); - - if ( rc < 0 ) { - uint8_t *type_val; - rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_SESSION_TYPE, &type_val ); + text_response_pkt->reserved = 0; - if ( (rc >= 0) && (type_val != NULL) && (strcasecmp( (char *) type_val, "Discovery" ) == 0) ) { - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); - iscsi_connection_pdu_destroy( response_pdu ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - } else { - uint8_t *type_val; - rc = iscsi_get_key_value_pair( conn->session->key_value_pairs, ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_SESSION_TYPE, &type_val ); - - if ( (rc >= 0) && (type_val != NULL) && (strcasecmp( (char *) type_val, "Discovery" ) == 0) ) { - if ( send_targets_val[0] == '\0' ) - send_targets_val = (uint8_t *) "ALL"; - - ds_len = iscsi_target_node_send( conn, send_targets_val, conn->init_name, (uint8_t *) response_pdu->ds_cmd_data, ds_len, response_pdu->len ); - } else { - if ( send_targets_val[0] == '\0' ) - send_targets_val = conn->target_port->name; - - if ( strcasecmp( (char *) send_targets_val, "ALL" ) == 0 ) { - iscsi_key_value_pair *key_value_pair; - rc = iscsi_hashmap_get( iscsi_globvec->session_key_value_pairs, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_SEND_TARGETS, strlen( (char *) ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_SEND_TARGETS ) + 1, (uint8_t **) &key_value_pair); - - if ( rc < 0 ) { - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); - iscsi_connection_pdu_destroy( response_pdu ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - ds_len = iscsi_append_key_value_pair_packet( key_value_pair, ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_SEND_TARGETS, (uint8_t *) "Reject", (uint8_t *) response_pdu->ds_cmd_data, ds_len, response_pdu->len ); - } else { - ds_len = iscsi_target_node_send( conn, send_targets_val, conn->init_name, (uint8_t *) response_pdu->ds_cmd_data, ds_len, response_pdu->len ); - } - } - - if ( conn->target_send_total_size == 0U ) { - text_response_pkt->flags |= (int8_t) ISCSI_TEXT_RESPONSE_FLAGS_CONTINUE; - text_response_pkt->flags &= (int8_t) ~ISCSI_TEXT_RESPONSE_FLAGS_FINAL; - } - } - - if ( ds_len < 0L ) { - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); - iscsi_connection_pdu_destroy( response_pdu ); - - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } - - if ( conn->target_send_total_size == 0U ) { - iscsi_hashmap_iterate( key_value_pairs, iscsi_hashmap_key_destroy_value_callback, NULL ); - iscsi_hashmap_destroy( key_value_pairs ); - } else { - conn->text_key_value_pairs = key_value_pairs; - } - - text_response_pkt = (iscsi_text_response_packet *) iscsi_connection_pdu_append( response_pdu, response_pdu->ahs_len, conn->header_digest, ds_len, conn->data_digest ); - - iscsi_put_be32( (uint8_t *) &text_response_pkt->total_ahs_len, ds_len ); // TotalAHSLength is always 0 and DataSegmentLength is 24-bit, so write in one step. + iscsi_put_be32( (uint8_t *) &text_response_pkt->total_ahs_len, payload_len ); // TotalAHSLength is always 0 and DataSegmentLength is 24-bit, so write in one step. text_response_pkt->lun = text_req_pkt->lun; // Copying over doesn't change endianess. text_response_pkt->init_task_tag = text_req_pkt->init_task_tag; // Copying over doesn't change endianess. @@ -13434,7 +3943,7 @@ static int iscsi_connection_pdu_data_handle_text_req(iscsi_connection *conn, isc conn->session->current_text_init_task_tag = 0xFFFFFFFFUL; } else { - iscsi_put_be32( (uint8_t *) &text_response_pkt->target_xfer_tag, ((uint32_t) conn->id + 1UL) ); + iscsi_put_be32( (uint8_t *) &text_response_pkt->target_xfer_tag, (uint32_t) conn->id + 1UL ); } iscsi_put_be32( (uint8_t *) &text_response_pkt->stat_sn, conn->stat_sn++ ); @@ -13447,34 +3956,12 @@ static int iscsi_connection_pdu_data_handle_text_req(iscsi_connection *conn, isc text_response_pkt->reserved2[0] = 0ULL; text_response_pkt->reserved2[1] = 0ULL; - iscsi_connection_pdu_write( conn, response_pdu, iscsi_connection_pdu_text_complete, (uint8_t *) conn ); + iscsi_connection_pdu_write( conn, response_pdu ); return ISCSI_CONNECT_PDU_READ_OK; } /** - * @brief Handles an incoming iSCSI payload data SCSI data out request PDU. - * - * This function handles SCSI data out request - * payload data sent by the client.\n - * If a response needs to be sent, this will - * be done as well. - * - * @param[in] conn Pointer to iSCSI connection to handle. May - * NOT be NULL, so take caution. - * @param[in] pdu Pointer to iSCSI client request PDU to handle. - * May be NULL in which case an error is returned. - * @return 0 on success. A negative value indicates - * an error. A positive value a warning. - */ -static int iscsi_connection_pdu_data_handle_scsi_data_out(iscsi_connection *conn, iscsi_pdu *pdu) -{ - // TODO: Implement opcode. - - return 0; -} - -/** * @brief Handles an incoming iSCSI payload data PDU. * * This function handles all payload data sent @@ -13516,11 +4003,6 @@ static int iscsi_connection_pdu_data_handle(iscsi_connection *conn, iscsi_pdu *p break; } - case ISCSI_OPCODE_CLIENT_SCSI_DATA_OUT : { - rc = iscsi_connection_pdu_data_handle_scsi_data_out( conn, pdu ); - - break; - } case ISCSI_OPCODE_CLIENT_TASK_FUNC_REQ : case ISCSI_OPCODE_CLIENT_LOGOUT_REQ : case ISCSI_OPCODE_CLIENT_SNACK_REQ : { @@ -13533,9 +4015,9 @@ static int iscsi_connection_pdu_data_handle(iscsi_connection *conn, iscsi_pdu *p } } - if ( rc < 0 ) - logadd( LOG_ERROR, "Fatal error during payload handler (opcode 0x%02x) detected for device %s", (int) opcode, (conn->device != NULL ? (char *) conn->device->name : "(null)") ); - + if ( rc < 0 ) { + logadd( LOG_ERROR, "Fatal error during payload handler (opcode 0x%02x) detected for client %s", (int) opcode, conn->client->hostName ); + } return rc; } @@ -13543,12 +4025,14 @@ static int iscsi_connection_pdu_data_handle(iscsi_connection *conn, iscsi_pdu *p * @brief Retrieves and merges splitted iSCSI PDU data read from TCP/IP socket. * * This function handles partial reads of data - * packet.\n - * Since iSCSI data can span multiple packets, not - * only by TCP/IP itself, but also by iSCSI protocol - * specifications, multiple calls are needed in order - * to be sure that all data packets have been - * received. + * packets.\n + * The function is guaranteed to read as many bytes as indicated by the + * PDU struct, unless the read timeout is reached, or the connection + * is closed/reset.\n + * Care is also taken for padding bytes that have to be read. It is + * assumed the according buffer will have enough space for the padding + * bytes, which is always guaranteed when using the create and resize + * helpers for allocating PDUs. * * @param[in] conn Pointer to iSCSI connection to read TCP/IP data from. * @param[in] pdu Pointer to iSCSI PDU to read TCP/IP data into. @@ -13556,38 +4040,21 @@ static int iscsi_connection_pdu_data_handle(iscsi_connection *conn, iscsi_pdu *p * @retval 0 Read operation was successful and next read is ready. * @retval 1 Read operation was successful and PDU was fully processed. */ -int iscsi_connection_pdu_data_read(iscsi_connection *conn, iscsi_pdu *pdu) +static int iscsi_connection_pdu_data_read(iscsi_connection *conn, iscsi_pdu *pdu) { - const uint32_t ds_len = pdu->ds_len; + const uint32_t ds_len = ISCSI_ALIGN( pdu->ds_len, ISCSI_ALIGN_SIZE ); - if ( pdu->pos < ds_len ) { - const int32_t len = iscsi_connection_read( conn, (((uint8_t *) pdu->ds_cmd_data) + pdu->pos), (ds_len - pdu->pos) ); + if ( pdu->recv_pos < ds_len ) { + const int32_t len = iscsi_connection_read( conn, (((uint8_t *) pdu->ds_cmd_data) + pdu->recv_pos), (ds_len - pdu->recv_pos) ); if ( len < 0L ) return len; - pdu->pos += len; + pdu->recv_pos += len; } - if ( pdu->pos < ds_len ) - return ISCSI_CONNECT_PDU_READ_PROCESSED; - - if ( pdu->data_digest != NULL ) { - if ( (int) pdu->data_digest_pos < pdu->data_digest_size ) { - const int32_t len = iscsi_connection_read( conn, (((uint8_t *) pdu->data_digest) + pdu->data_digest_pos), (pdu->data_digest_size - pdu->data_digest_pos) ); - - if ( len < 0L ) - return len; - - pdu->data_digest_pos += len; - - if ( (int) pdu->data_digest_pos < pdu->data_digest_size ) - return ISCSI_CONNECT_PDU_READ_OK; - } - - if ( !iscsi_connection_pdu_digest_data_verify( pdu->data_digest, pdu->ds_cmd_data, ds_len ) ) - return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - } + if ( pdu->recv_pos < ds_len ) + return ISCSI_CONNECT_PDU_READ_ERR_FATAL; return ISCSI_CONNECT_PDU_READ_OK; } @@ -13619,7 +4086,8 @@ static int iscsi_connection_pdu_read(iscsi_connection *conn) switch ( conn->pdu_recv_state ) { case ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_READY : { - conn->pdu_processing = iscsi_connection_pdu_create( conn, 0U, conn->header_digest, 0UL, conn->data_digest ); + assert( conn->pdu_processing == NULL ); + conn->pdu_processing = iscsi_connection_pdu_create( conn, 0UL ); if ( conn->pdu_processing == NULL ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; @@ -13629,116 +4097,62 @@ static int iscsi_connection_pdu_read(iscsi_connection *conn) break; } case ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_HDR : { - if ( pdu->bhs_pos < sizeof(struct iscsi_bhs_packet) ) { + while ( pdu->bhs_pos < sizeof(struct iscsi_bhs_packet) ) { const int32_t len = iscsi_connection_read( conn, (((uint8_t *) pdu->bhs_pkt) + pdu->bhs_pos), (sizeof(struct iscsi_bhs_packet) - pdu->bhs_pos) ); if ( len < 0L ) { conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; - break; + return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } pdu->bhs_pos += len; - - if ( pdu->bhs_pos < sizeof(struct iscsi_bhs_packet) ) - return ISCSI_CONNECT_PDU_READ_OK; } if ( (conn->flags & ISCSI_CONNECT_FLAGS_LOGGED_OUT) != 0 ) { conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; - break; + return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } iscsi_bhs_packet *bhs_pkt = pdu->bhs_pkt; - const uint ahs_len = ((uint) bhs_pkt->total_ahs_len << 2U); + const uint ahs_len = ((uint) bhs_pkt->total_ahs_len * 4); const uint32_t ds_len = iscsi_get_be24(bhs_pkt->ds_len); - bhs_pkt = iscsi_connection_pdu_append( pdu, ahs_len, conn->header_digest, ds_len, conn->data_digest ); + bhs_pkt = iscsi_connection_pdu_resize( pdu, ahs_len, ds_len ); if ( bhs_pkt == NULL ) return ISCSI_CONNECT_PDU_READ_ERR_FATAL; - uint64_t stat_opcode = (uint64_t) ISCSI_GET_OPCODE(bhs_pkt->opcode); - uint64_t *stat_value = NULL; - int stat_rc = iscsi_hashmap_get( conn->stat_iscsi_opcodes, (uint8_t *) &stat_opcode, sizeof(stat_opcode), (uint8_t **) &stat_value ); - - if ( stat_value == NULL ) { - stat_value = malloc( sizeof(uint64_t) ); - - if ( stat_value != NULL ) { - uint8_t *stat_key = iscsi_hashmap_key_create( (uint8_t *) &stat_opcode, sizeof(stat_opcode) ); - - if ( stat_key != NULL ) { - *stat_value = 0ULL; - - stat_rc = iscsi_hashmap_put( conn->stat_iscsi_opcodes, stat_key, sizeof(stat_opcode), (uint8_t *) stat_value ); - - if ( stat_rc < 0 ) { - iscsi_hashmap_key_destroy( stat_key ); - free( stat_value ); - stat_value = NULL; - } - } else { - free( stat_value ); - stat_value = NULL; - } - } - } - - if ( stat_value != NULL ) - (*stat_value)++; - - if ( pdu->ahs_pos < ahs_len ) { - const int32_t len = iscsi_connection_read( conn, (((uint8_t *) pdu->ahs_pkt) + pdu->ahs_pos), (ahs_len - pdu->ahs_pos) ); + int pos = 0; + while ( pos < ahs_len ) { + const int32_t len = iscsi_connection_read( conn, (((uint8_t *) pdu->ahs_pkt) + pos), (ahs_len - pos) ); if ( len < 0L ) { conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; - break; + return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } - pdu->ahs_pos += len; - - if ( pdu->ahs_pos < ahs_len ) - return ISCSI_CONNECT_PDU_READ_OK; - } - - if ( pdu->header_digest != NULL ) { - if ( (int) pdu->header_digest_pos < pdu->header_digest_size ) { - const int32_t len = iscsi_connection_read( conn, (((uint8_t *) pdu->header_digest) + pdu->header_digest_pos), (pdu->header_digest_size - pdu->header_digest_pos) ); - - if ( len < 0L ) { - conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; - - break; - } - - pdu->header_digest_pos += len; - - if ( (int) pdu->header_digest_pos < pdu->header_digest_size ) - return ISCSI_CONNECT_PDU_READ_OK; - } - - if ( !iscsi_connection_pdu_digest_header_verify( pdu->header_digest, bhs_pkt, ahs_len ) ) { - conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; - - break; - } + pos += len; } - conn->pdu_recv_state = ((iscsi_connection_pdu_header_handle( conn, pdu ) < 0) ? ISCSI_CONNECT_PDU_RECV_STATE_ERR : ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_DATA); + if ( iscsi_connection_pdu_header_handle( conn, pdu ) < 0 ) { + conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; + } else { + conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_DATA; + } break; } case ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_DATA : { - if ( pdu->ds_len != 0UL ) { + if ( pdu->ds_len != 0U ) { const int len = iscsi_connection_pdu_data_read( conn, pdu ); if ( len < 0 ) { conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; - break; + return ISCSI_CONNECT_PDU_READ_ERR_FATAL; } else if ( len > 0 ) { return ISCSI_CONNECT_PDU_READ_OK; } @@ -13746,21 +4160,21 @@ static int iscsi_connection_pdu_read(iscsi_connection *conn) int rc; - if ( (conn->flags & ISCSI_CONNECT_FLAGS_REJECTED) != 0 ) + conn->pdu_processing = NULL; + if ( (conn->flags & ISCSI_CONNECT_FLAGS_REJECTED) != 0 ) { rc = 0; - else + } else { rc = iscsi_connection_pdu_data_handle( conn, pdu ); + } - if ( rc == 0 ) { - iscsi_connection_pdu_destroy( pdu ); + iscsi_connection_pdu_destroy( pdu ); - conn->pdu_processing = NULL; + if ( rc == 0 ) { conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_READY; return ISCSI_CONNECT_PDU_READ_PROCESSED; - } else { - conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; } + conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_ERR; break; } @@ -13770,7 +4184,8 @@ static int iscsi_connection_pdu_read(iscsi_connection *conn) break; } default : { - logadd( LOG_ERROR, "iscsi_connection_pdu_read: Fatal error reading, unknown packet status. Should NEVER happen! Please report this bug to the developer" ); + logadd( LOG_ERROR, "iscsi_connection_pdu_read: Fatal error reading, unknown packet status." + " Should NEVER happen! Please report this bug to the developer" ); break; } @@ -13780,64 +4195,6 @@ static int iscsi_connection_pdu_read(iscsi_connection *conn) return 0; } -#define ISCSI_PDU_HANDLE_COUNT 16 - -/** - * @brief Handles incoming PDU data, read up to 16 fragments at once. - * - * Until iSCSI processing has been stopped or a - * complete iSCSI packet has been read, this - * function will read, parse and process - * incoming iSCSI protocol data. - * - * @param[in] conn Pointer to iSCSI connection to handle. - * @return Number of proccessed fragments or return - * code of iscsi_connection_pdu_read in case of a - * fatal error. - */ -int iscsi_connection_pdu_handle(iscsi_connection *conn) -{ - int i; - - for ( i = 0; i < ISCSI_PDU_HANDLE_COUNT; i++ ) { - const int rc = iscsi_connection_pdu_read( conn ); - - while ( !iscsi_list_empty( &conn->exec_queue ) ) { - iscsi_connection_exec_queue *exec_queue = (iscsi_connection_exec_queue *) iscsi_list_peek( &conn->exec_queue ); - - iscsi_list_remove( &exec_queue->node ); - - switch ( exec_queue->type ) { - case ISCSI_CONNECT_EXEC_QUEUE_TYPE_SCSI_EMU_IO : { - exec_queue->data.io.callback( exec_queue->data.io.image, exec_queue->data.io.user_data, exec_queue->data.io.success ); - - break; - } - case ISCSI_CONNECT_EXEC_QUEUE_TYPE_PDU_WRITE : { - exec_queue->data.pdu_write.callback( exec_queue->data.pdu_write.user_data, exec_queue->data.pdu_write.err ); - - break; - } - default : { - break; - } - } - - free( exec_queue ); - } - - if ( rc == ISCSI_CONNECT_PDU_READ_OK ) - break; - else if ( rc == ISCSI_CONNECT_PDU_READ_ERR_FATAL ) - return rc; - - if ( (conn->flags & ISCSI_CONNECT_FLAGS_STOPPED) != 0 ) - break; - } - - return i; -} - /** * @brief Handles an iSCSI connection until connection is closed. * @@ -13854,173 +4211,22 @@ int iscsi_connection_pdu_handle(iscsi_connection *conn) */ void iscsi_connection_handle(dnbd3_client_t *client, const dnbd3_request_t *request, const int len) { - _Static_assert( sizeof(dnbd3_request_t) <= sizeof(struct iscsi_bhs_packet), "DNBD3 request size larger than iSCSI BHS packet data size - Manual intervention required!" ); + _Static_assert( sizeof(dnbd3_request_t) <= sizeof(struct iscsi_bhs_packet), + "DNBD3 request size larger than iSCSI BHS packet data size - Manual intervention required!" ); sock_setTimeout( client->sock, 1000L * 3600L ); // TODO: Remove after finishing iSCSI implementation - pthread_rwlock_rdlock( &iscsi_globvec_rwlock ); - - if ( iscsi_globvec == NULL ) - return; - - uint64_t *hash_key; - iscsi_portal_group *portal_group = NULL; - - pthread_rwlock_wrlock( &iscsi_globvec->portal_groups_rwlock ); - - int rc = iscsi_hashmap_get( iscsi_globvec->portal_groups, (uint8_t *) &iscsi_globvec->portal_groups->last_insert_id, sizeof(iscsi_globvec->portal_groups->last_insert_id), (uint8_t **) &portal_group ); - - if ( portal_group == NULL ) { - hash_key = (uint64_t *) malloc( sizeof(uint64_t) ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_handle: Out of memory while allocating iSCSI portal group" ); - - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - - iscsi_hashmap_key_create_id( iscsi_globvec->portal_groups, hash_key ); - portal_group = iscsi_portal_group_create( *hash_key, 0 ); - - if ( portal_group == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_handle: Out of memory while allocating iSCSI portal group" ); - - iscsi_hashmap_key_destroy( (uint8_t *) hash_key ); - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - - portal_group->tag = *hash_key; - - iscsi_hashmap_key_destroy( (uint8_t *) hash_key ); - - rc = iscsi_hashmap_put( iscsi_globvec->portal_groups, (uint8_t *) &portal_group->tag, sizeof(portal_group->tag), (uint8_t *) portal_group ); - - if ( rc < 0 ) { - iscsi_portal_group_destroy( portal_group ); - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - } - - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - host_to_string( &client->host, client->hostName, HOSTNAMELEN ); - - const uint8_t *port = memchr( client->hostName, ':', HOSTNAMELEN ); - const uint host_len = ((port != NULL) ? (uint) (port++ - (uint8_t *) client->hostName) : (uint) strlen( client->hostName )); - uint8_t *host = malloc( (host_len + 1U) ); - - if ( host == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_handle: Out of memory while allocating iSCSI portal host name" ); - - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - - memcpy( host, client->hostName, host_len ); - host[host_len] = '\0'; - - uint8_t *tmp_buf; - - if ( port != NULL ) - tmp_buf = iscsi_sprintf_alloc( "%s:%s", host, port ); - else - tmp_buf = iscsi_sprintf_alloc( "%s:%u", host, PORT ); - - if ( tmp_buf == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_handle: Out of memory while allocating temporarily iSCSI portal name" ); - - free( host ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - - const uint key_len = (uint) (strlen( (char *) tmp_buf ) + 1U); - - hash_key = (uint64_t *) iscsi_hashmap_key_create( tmp_buf, key_len ); - - free( tmp_buf ); - - if ( hash_key == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_handle: Out of memory while allocating temporarily iSCSI portal name hash key" ); - - free( host ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - - iscsi_portal *portal = NULL; - - pthread_rwlock_wrlock( &iscsi_globvec->portal_groups_rwlock ); - rc = iscsi_hashmap_get( portal_group->portals, (uint8_t *) hash_key, key_len, (uint8_t **) &portal ); - - if ( portal == NULL ) { - if ( port == NULL ) { - port = (uint8_t *) strchr( (char *) hash_key, ':' ); - port++; - } - - portal = iscsi_portal_create( host, port ); - - if ( portal == NULL ) { - logadd( LOG_ERROR, "iscsi_connection_handle: Out of memory while allocating iSCSI portal" ); - - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - iscsi_hashmap_key_destroy( (uint8_t *) hash_key ); - free( host ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - - rc = iscsi_portal_group_add_portal( portal_group, portal ); - - if ( rc < 0 ) { - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - iscsi_portal_destroy( portal ); - iscsi_hashmap_key_destroy( (uint8_t *) hash_key ); - free( host ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - - return; - } - } - - iscsi_hashmap_key_destroy( (uint8_t *) hash_key ); - free( host ); - - iscsi_connection *conn = iscsi_connection_create( portal, client->sock ); + iscsi_connection *conn = iscsi_connection_create( client ); if ( conn == NULL ) { logadd( LOG_ERROR, "iscsi_connection_handle: Out of memory while allocating iSCSI connection" ); - iscsi_portal_group_del_portal( portal_group, portal ); - iscsi_portal_destroy( portal ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); - return; } - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - - conn->pdu_processing = iscsi_connection_pdu_create( conn, 0U, 0, 0UL, 0 ); + conn->pdu_processing = iscsi_connection_pdu_create( conn, 0UL ); if ( conn->pdu_processing == NULL ) { iscsi_connection_destroy( conn ); - pthread_rwlock_wrlock( &iscsi_globvec->portal_groups_rwlock ); - iscsi_portal_group_del_portal( portal_group, portal ); - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - iscsi_portal_destroy( portal ); - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); return; } @@ -14028,52 +4234,15 @@ void iscsi_connection_handle(dnbd3_client_t *client, const dnbd3_request_t *requ memcpy( conn->pdu_processing->bhs_pkt, request, len ); conn->pdu_processing->bhs_pos = len; - conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_HDR; - - logadd( LOG_INFO, "" ); - logadd( LOG_INFO, "iSCSI connection opened for device %s from initiator %s using port %s and portal %s:%s", (conn->device != NULL ? (char *) conn->device->name : "(null)"), (char *) conn->init_name, ((conn->init_port != NULL) ? (char *) conn->init_port->name : "(null)"), (char *) portal->host, (char *) portal->port ); - - while ( iscsi_connection_pdu_handle( conn ) >= ISCSI_CONNECT_PDU_READ_OK ) { - } - - iscsi_hashmap_bucket *stat_bucket; - - logadd( LOG_INFO, "iSCSI connection closed for device %s from initiator %s using port %s and portal %s:%s", (conn->device != NULL ? (char *) conn->device->name : "(null)"), (char *) conn->init_name, ((conn->init_port != NULL) ? (char *) conn->init_port->name : "(null)"), (char *) portal->host, (char *) portal->port ); - - iscsi_list_foreach_node ( &conn->stat_iscsi_opcodes->list, stat_bucket ) { - uint64_t *stat_opcode = (uint64_t *) stat_bucket->value; - - logadd( LOG_INFO, "iSCSI opcode usage statistics for device %s from initiator %s using port %s and portal %s:%s: Opcode 0x%02" PRIX64 " has been received %" PRIu64 " times until connection drop.", (conn->device != NULL ? (char *) conn->device->name : "(null)"), (char *) conn->init_name, ((conn->init_port != NULL) ? (char *) conn->init_port->name : "(null)"), (char *) portal->host, (char *) portal->port, *(uint64_t *) stat_bucket->key, *stat_opcode ); - } - - iscsi_list_foreach_node ( &conn->stat_scsi_opcodes->list, stat_bucket ) { - uint64_t *stat_opcode = (uint64_t *) stat_bucket->value; - - logadd( LOG_INFO, "iSCSI SCSI CDB opcode usage statistics for device %s from initiator %s using port %s and portal %s:%s: SCSI CDB opcode 0x%02" PRIX64 " has been received %" PRIu64 " times until connection drop.", (conn->device != NULL ? (char *) conn->device->name : "(null)"), (char *) conn->init_name, ((conn->init_port != NULL) ? (char *) conn->init_port->name : "(null)"), (char *) portal->host, (char *) portal->port, *(uint64_t *) stat_bucket->key, *stat_opcode ); - } + conn->pdu_recv_state = ISCSI_CONNECT_PDU_RECV_STATE_WAIT_PDU_HDR; - iscsi_session *session = conn->session; - - if ( session != NULL ) { - pthread_rwlock_wrlock( &iscsi_globvec->sessions_rwlock ); - iscsi_list_remove( &conn->node ); - - if ( --session->conns == 0UL ) { - const uint64_t tsih = session->tsih; - - iscsi_hashmap_remove( iscsi_globvec->sessions, (uint8_t *) &tsih, sizeof(tsih) ); - iscsi_session_destroy( session ); - } + static atomic_int CONN_ID = 0; + conn->id = ++CONN_ID; - pthread_rwlock_unlock( &iscsi_globvec->sessions_rwlock ); + while ( iscsi_connection_pdu_read( conn ) >= ISCSI_CONNECT_PDU_READ_OK ) { + if ( (conn->flags & ISCSI_CONNECT_FLAGS_STOPPED) != 0 ) + break; } iscsi_connection_destroy( conn ); - - pthread_rwlock_wrlock( &iscsi_globvec->portal_groups_rwlock ); - iscsi_portal_group_del_portal( portal_group, portal ); - iscsi_portal_destroy( portal ); - pthread_rwlock_unlock( &iscsi_globvec->portal_groups_rwlock ); - - pthread_rwlock_unlock( &iscsi_globvec_rwlock ); } diff --git a/src/server/iscsi.h b/src/server/iscsi.h index ded2d1d..0c279fe 100644 --- a/src/server/iscsi.h +++ b/src/server/iscsi.h @@ -32,10 +32,6 @@ #ifndef DNBD3_ISCSI_H_ #define DNBD3_ISCSI_H_ -#ifdef __cplusplus -extern "C" { -#endif - #include <limits.h> #include <stdbool.h> #include <stdint.h> @@ -48,23 +44,23 @@ extern "C" { #include "image.h" #if defined(__GNUC__) && (defined(__x86_64__) || defined(__i386__)) - // GCC-compatible compiler, targeting x86/x86-64 - #include <x86intrin.h> + // GCC-compatible compiler, targeting x86/x86-64 + #include <x86intrin.h> #elif defined(__GNUC__) && defined(__ARM_NEON__) - // GCC-compatible compiler, targeting ARM with NEON - #include <arm_neon.h> + // GCC-compatible compiler, targeting ARM with NEON + #include <arm_neon.h> #elif defined(__GNUC__) && defined(__IWMMXT__) - // GCC-compatible compiler, targeting ARM with WMMX - #include <mmintrin.h> + // GCC-compatible compiler, targeting ARM with WMMX + #include <mmintrin.h> #elif (defined(__GNUC__) || defined(__xlC__)) && (defined(__VEC__) || defined(__ALTIVEC__)) - // XLC or GCC-compatible compiler, targeting PowerPC with VMX/VSX - #include <altivec.h> + // XLC or GCC-compatible compiler, targeting PowerPC with VMX/VSX + #include <altivec.h> #elif defined(__GNUC__) && defined(__SPE__) - // GCC-compatible compiler, targeting PowerPC with SPE - #include <spe.h> + // GCC-compatible compiler, targeting PowerPC with SPE + #include <spe.h> #elif defined(_MSC_VER) - // Microsoft C/C++-compatible compiler - #include <intrin.h> + // Microsoft C/C++-compatible compiler + #include <intrin.h> #endif #if defined(__BIG_ENDIAN__) || (defined(__BYTE_ORDER) && defined(__BIG_ENDIAN) && __BYTE_ORDER == __BIG_ENDIAN) || (defined(__BYTE_ORDER__) && defined(__ORDER_BIG_ENDIAN__) && __BYTE_ORDER__ == __ORDER_BIG_ENDIAN__) @@ -241,76 +237,6 @@ static inline bool iscsi_is_pow2(const uint32_t value) return ((value & (value - 1UL)) == 0UL); } -/** - * @brief Rounds up a positive 32-bit integer value to the nearest power of two. - * - * This function is used to ensure that - * a value is always a power of two by - * rounding up.\n - * An input value of zero is NOT - * handled correctly. - * - * @param[in] value Positive value to round up to - * the nearest power of two. - * @return Rounded up nearest power of two. - */ -static inline uint32_t iscsi_align_pow2_ceil(const uint32_t value) -{ - uint32_t num_value = (value - 1UL); // 1UL << (lg(value - 1UL) + 1UL) - - num_value |= (num_value >> 1UL); - num_value |= (num_value >> 2UL); - num_value |= (num_value >> 4UL); - num_value |= (num_value >> 8UL); - num_value |= (num_value >> 16UL); - - return ++num_value; -} - -/** - * @brief Calculates the shift factor for a power of two value. - * - * This function is used to determine - * the shift factor to use instead of - * using very slow multiplication, - * division and modulo operations. - * - * @param[in] value Value to retrieve the - * the shift factor for. May NOT be - * zero in which case the result is - * undefined. - * @return The shift count to use as a - * replacement for multiplication - * and division. - */ -static inline uint32_t iscsi_get_log2_of_pow2(const uint32_t value) -{ -#if defined(__clang__) || defined(__GNUC__) || defined(__GNUG__) || defined(__INTEL_COMPILER) || defined(__ECC) -// GCC, CLang or Intel Compiler - return (((sizeof(uint32_t) * CHAR_BIT) - 1UL) - (uint32_t) __builtin_clz( value )); -#elif defined(_MSC_VER) -// MSVC - uint32_t shift; - - _BitScanReverse( &shift, value ); - - return (((sizeof(uint32_t) * CHAR_BIT) - 1UL) - shift); -#else -// Other compilers (use slow parallel calculation method with logical OR, bit shift, logcal AND) - uint32_t shift = ((value & 0xAAAAAAAAUL) != 0UL); - - shift |= ((value & 0xCCCCCCCCUL) != 0UL) << 1UL; - shift |= ((value & 0xF0F0F0F0UL) != 0UL) << 2UL; - shift |= ((value & 0xFF00FF00UL) != 0UL) << 3UL; - shift |= ((value & 0xFFFF0000UL) != 0UL) << 4UL; - - return shift; -#endif -} - - -/// Determines the container of member b in struct a of type x. -#define ISCSI_CONTAINER(x, a, b) ((x *) (((uint8_t *) (a)) - offsetof(x, b))) /// Determines the next offset after member b of struct a. #define ISCSI_NEXT_OFFSET(a, b) (offsetof(struct a, b) + sizeof(((struct a *) 0)->b)) @@ -365,434 +291,7 @@ static inline uint32_t iscsi_get_log2_of_pow2(const uint32_t value) /// Determines the length of a zero terminated string at compile time. -#define ISCSI_STRLEN(x) ((sizeof(x) / sizeof(uint8_t)) - sizeof(uint8_t)) - - -uint8_t *iscsi_vsprintf_append_realloc(char *buf, const char *format, va_list args); // Allocates and appends a buffer and sprintf's it -uint8_t *iscsi_sprintf_append_realloc(char *buf, const char *format, ...); // Allocates and appends a buffer and sprintf's it -uint8_t *iscsi_vsprintf_alloc(const char *format, va_list args); // Allocates a buffer and sprintf's it -uint8_t *iscsi_sprintf_alloc(const char *format, ... ); // Allocates a buffer and sprintf's it -void iscsi_strcpy_pad(char *dst, const char *src, const size_t size, const int pad); // Copies a string with additional padding character to fill in a specified size - - -/// Shift factor for default capacity. -#define ISCSI_HASHMAP_DEFAULT_CAPACITY_SHIFT 5UL - -/// Default capacity is 32 buckets. -#define ISCSI_HASHMAP_DEFAULT_CAPACITY (1UL << (ISCSI_HASHMAP_DEFAULT_CAPACITY_SHIFT)) - -/// Number of bits to shift left when resizing. -#define ISCSI_HASHMAP_RESIZE_SHIFT 1UL - -/// Key data shift value for alignment enforcement. -#define ISCSI_HASHMAP_KEY_ALIGN_SHIFT 3UL - -/// Key data size MUST be multiple of 8 bytes by now. -#define ISCSI_HASHMAP_KEY_ALIGN (1UL << (ISCSI_HASHMAP_KEY_ALIGN_SHIFT)) - - -/// Initial hash code. -#define ISCSI_HASHMAP_HASH_INITIAL 0x811C9DC5UL - -/// Value to multiply hash code with. -#define ISCSI_HASHMAP_HASH_MUL 0xBF58476D1CE4E5B9ULL - - -typedef struct iscsi_node iscsi_node; - - -/** - * @brief Doubly linked list node structure. - * - * This structure is used by the iSCSI doubly linked list - * implementation in order to maintain the elements. - */ -typedef struct iscsi_node { - /// Successor node in node list. Must be first element. - iscsi_node *succ; - - /// Predecessor node in node list. Must be second element. - iscsi_node *pred; -} iscsi_node; - - -/** - * @brief Doubly linked list structure. - * - * This structure is used by the iSCSI doubly linked list - * implementation in order to maintain the elements. - */ -typedef struct iscsi_list { - /// Head of linked list. Must be first element. - iscsi_node *head; - - /// Tail of linked list. Must be second element and always be NULL. - iscsi_node *tail; - - /// Tail predecessor of linked list. Must be third element. - iscsi_node *pred; -} iscsi_list; - - -/// foreach( ( list => entry ) usage style forward iterator over all nodes in a doubly linked list. -#define iscsi_list_foreach(list, entry) for ( (entry) = (list)->head; (entry)->succ != NULL; (entry) = (entry)->succ ) - -/// foreach( ( list => (typeof(entry)) as field ) usage style forward iterator over all nodes in a doubly linked list embedded into another structure with default node field name. -#define iscsi_list_foreach_field(list, entry, field) for ( (entry) = (__typeof__(entry)) (list)->head; (__typeof__(entry)) (entry)->field.succ != NULL; (entry) = (__typeof__(entry)) (entry)->field.succ ) - -/// foreach( ( list => (typeof(entry)) entry->node.succ ) usage style forward iterator over all nodes in a doubly linked list embedded into another structure with default node field name. -#define iscsi_list_foreach_node(list, entry) iscsi_list_foreach_field(list, entry, node) - -/// foreach( ( list => entry ) usage style forward iterator over all nodes in a doubly linked list. -#define iscsi_list_foreach_safe(list, entry, tmp) for ( (entry) = (list)->head; ((entry)->succ != NULL) && ((tmp) = (entry)->succ, true); (entry) = (tmp) ) - -/// foreach( ( list => (typeof(entry)) as field ) usage style forward iterator over all nodes in a doubly linked list embedded into another structure with default node field name. -#define iscsi_list_foreach_safe_field(list, entry, field, tmp) for ( (entry) = (__typeof__(entry)) (list)->head; ((entry)->field.succ != NULL) && ((tmp) = (__typeof__(entry)) (entry)->field.succ, true); (entry) = (tmp) ) - -/// foreach( ( list => (typeof(entry)) entry->node.succ ) usage style forward iterator over all nodes in a doubly linked list embedded into another structure with default node field name. -#define iscsi_list_foreach_safe_node(list, entry, tmp) iscsi_list_foreach_safe_field(list, entry, node, tmp) - - -/** - * @brief Initializes a doubly linked list for usage. - * - * This function sets the head of the list to - * the pointer of the list's tail, the tail - * itself to NULL and the predecessor to the - * pointer of the list's head. - * - * @param[in] list Pointer to idoubly linked list to - * initialize. May NOT be NULL, so be careful. - * */ -static inline void iscsi_list_create(iscsi_list *list) -{ - list->head = (iscsi_node *) &list->tail; - list->tail = NULL; - list->pred = (iscsi_node *) &list->head; -} - -/** - * @brief Clears an already initialized doubly linked list. - * - * This function sets the head of the list to - * the pointer of the list's tail and the - * predecessor to the pointer of the list's - * head. - * - * @param[in] list Pointer to idoubly linked list to - * initialize. May NOT be NULL, so be careful. - * */ -static inline void iscsi_list_clear(iscsi_list *list) -{ - list->head = (iscsi_node *) &list->tail; - list->pred = (iscsi_node *) &list->head; -} - -/** - * @brief Adds a node at the head of a doubly linked list. - * - * This function sets the head of the list to - * the node and adjusts the list and node - * pointers accordingly. - * - * @param[in] list Pointer to doubly linked list to add to - * the head. May NOT be NULL, so be careful. - * @param[in] node Pointer to node to add to the head of - * the list. NULL is NOT allowed here, take - * caution. - */ -static inline void iscsi_list_push(iscsi_list *list, iscsi_node *node) -{ - iscsi_node *head = list->head; - - list->head = node; - head->pred = node; - - node->succ = head; - node->pred = (iscsi_node *) &list->head; -} - -/** - * @brief Adds a node at the tail of a doubly linked list. - * - * This function sets the tail of the list to - * the node and adjusts the list and node - * pointers accordingly. - * - * @param[in] list Pointer to doubly linked list to add to - * the tail. May NOT be NULL, so be careful. - * @param[in] node Pointer to node to add to the tail of - * the list. NULL is NOT allowed here, take - * caution. - */ -static inline void iscsi_list_enqueue(iscsi_list *list, iscsi_node *node) -{ - iscsi_node *tail = list->pred; - - list->pred = node; - tail->succ = node; - - node->succ = (iscsi_node *) &list->tail; - node->pred = tail; -} - -/** - * @brief Inserts a node into a doubly linked list before an already existing node. - * - * This function sets the successor of the - * new node to the successor of the - * existing predecessor node and the - * predecessor of the new node to the - * the existing predecessor node itself - * and adjusts the list pointers - * accordingly. - * - * @param[in] list Pointer to doubly linked list to insert the - * node into. May NOT be NULL, so be careful. - * @param[in] node Pointer to node to be inserted into the - * list. NULL is NOT allowed here, take - * caution. - * @param[in] pred Pointer to node which should be the - * previous node of the new inserted node. - * May be NULL in which case the new node - * is inserted at the head of the list. - */ -static inline void iscsi_list_insert(iscsi_list *list, iscsi_node *node, iscsi_node *pred) -{ - if ( pred == NULL ) { - iscsi_node *head = list->head; - - list->head = node; - head->pred = node; - - node->succ = head; - node->pred = (iscsi_node *) &list->head; - - return; - } - - iscsi_node *tail = pred->succ; - - if ( tail == NULL ) { - tail = pred->pred; - - node->succ = pred; - node->pred = tail; - - pred->pred = node; - tail->succ = node; - - return; - } - - node->succ = tail; - node->pred = pred; - - tail->pred = node; - pred->succ = node; -} - -/** - * @brief Removes the node from the head of a doubly linked list. - * - * This function sets the head of the list to - * its successor and adjusts the list and - * node pointers accordingly. - * - * @param[in] list Pointer to doubly linked list to remove the - * head from. May NOT be NULL, so be careful. - */ -static inline void iscsi_list_pop(iscsi_list *list) -{ - iscsi_node *head = list->head; - iscsi_node *node = head->succ; - - if ( node == NULL ) - return; - - list->head = node; - - node->pred = (iscsi_node *) &list->head; -} - -/** - * @brief Removes the node from the tail of a doubly linked list. - * - * This function sets the tail of the list to - * its predecessor and adjusts the list and - * node pointers accordingly. - * - * @param[in] list Pointer to doubly linked list to remove the - * tail from. May NOT be NULL, so be careful. - */ -static inline void iscsi_list_dequeue(iscsi_list *list) -{ - iscsi_node *tail = list->pred; - iscsi_node *node = tail->pred; - - if ( node == NULL ) - return; - - list->pred = node; - - node->succ = (iscsi_node *) &list->tail; -} - -/** - * @brief Removes a specified node from a doubly linked list. - * - * This function sets the successor of the - * node's predecessor and the predecessor - * of the node's successor by adjusting - * the list and node pointers accordingly. - * - * @param[in] node Pointer to node to be removed from - * the list. May NOT be NULL, so - * be careful. - */ -static inline void iscsi_list_remove(iscsi_node *node) -{ - iscsi_node *succ = node->succ; - iscsi_node *pred = node->pred; - - pred->succ = succ; - succ->pred = pred; -} - -/** - * @brief Checks whether a doubly linked list is empty. - * - * Whenever this function returns false, - * iscsi_list_peek will return a pointer - * to the first node in the list. - * - * @param[in] list Pointer to doubly linked list to check if - * empty. May NOT be NULL, so be careful. - * @retval true The doubly linked list is empty. - * @retval false The doubly linked list contains nodes. - */ -static inline bool iscsi_list_empty(const iscsi_list *list) -{ - return (list->head->succ == NULL); -} - -/** - * @brief Gets the node from the head of a doubly linked list. - * - * This function returns NULL if the list is - * empty. - * - * @param[in] list Pointer to doubly linked list to get the - * head from. May NOT be NULL, so be careful. - * @return Pointer to doubly linked list node of the - * head or NULL if the list is empty. - */ -static inline iscsi_node *iscsi_list_peek(const iscsi_list *list) -{ - iscsi_node *head = list->head; - - return (head->succ != NULL) ? head : NULL; -} - - -/** - * @brief Hash map bucket containing key, value and hash code. - * - * This structure is used by the iSCSI hash map implementation - * in order to maintain the elements. - */ -typedef struct iscsi_hashmap_bucket { - /// Next bucket, MUST be first element. - iscsi_node node; - - /// Data used as key, MUST be aligned to 8 bytes and zero padded. - uint8_t *key; - - /// Size of key. - size_t key_size; - - /// Hash code for the key. - uint32_t hash; - - /// Associate4d value to the key, NULL is allowed. - uint8_t *value; -} iscsi_hashmap_bucket; - -/** - * @brief Hash map containing an expandable list of buckets - * - * This structure is used by the ultra performant hash map - * implementation. It uses a linked list allowing fast - * insertions. Elements can be removed. - */ -typedef struct iscsi_hashmap { - /// Linked list containing the hash map buckets. - iscsi_hashmap_bucket *buckets; - - /// Doubly linked list for fast insertion. - iscsi_list list; - - /// Last inserted unique identifier (primary key). - uint64_t last_insert_id; - - /// Current bucket capacity, MUST be a power of two. - uint capacity; - - /// Current capacity threshold triggering resize operation. - uint cap_load; - - /// Current count of buckets. - uint count; -} iscsi_hashmap; - -/** - * @brief Callback for iterating over map, freeing and removing entries. user_data is free for personal use. - * - * Callback function. This is a pointer to a - * function for various purposes like iterating - * through a hash map. It is also used for replacing - * already existing keys or for key removal. - * - * @param[in] key Pointer to zero padded key. NULL is - * an invalid pointer here, so be careful. - * @param[in] key_size Number of bytes for the key, MUST - * be a multiple of 8 bytes which is NOT checked, so - * be careful. - * @param[in] value Value of the key, NULL is allowed. - * @param[in,out] user_data User data to be used by the - * callback function. User data can be modified if - * desired and may also be NULL if the callback - * function handles this case. See the documentation - * of the callback implementation for details. - * @return A negative result indicates as fatal error, - * 0 means successful operation and a positive value - * indicates a non-fatal error or a warning. - */ -typedef int (*iscsi_hashmap_callback)(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); - -iscsi_hashmap *iscsi_hashmap_create(const uint capacity); // Creates an empty hash map with either specified or default capacity -void iscsi_hashmap_destroy(iscsi_hashmap *map); // Deallocates the hash map objects and buckets, not elements - // Use iscsi_hashmap_iterate to deallocate the elements themselves - -uint8_t *iscsi_hashmap_key_create(const uint8_t *data, const size_t len); // Creates a key suitable for hashmap usage (ensures 8-byte boundary and zero padding) -void iscsi_hashmap_key_create_id(iscsi_hashmap *map, uint64_t *key); // Creates an unique key identifier suitable for hashmap usage (ensures 8-byte boundary and zero padding) -void iscsi_hashmap_key_destroy(uint8_t *key); // Deallocates all resources acquired by iscsi_hashmap_create_key -int iscsi_hashmap_key_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Deallocates a key in a hash map -int iscsi_hashmap_destroy_value_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Deallocates a value in a hash map -int iscsi_hashmap_key_destroy_value_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Deallocates a key / value pair in a hash map by calling free (default destructor) - -int iscsi_hashmap_put(iscsi_hashmap *map, uint8_t *key, const size_t key_size, uint8_t *value); // Assigns key / value pair to hash map at the tail of doubly linked list without making copies -int iscsi_hashmap_get_put(iscsi_hashmap *map, uint8_t *key, const size_t key_size, uint8_t **out_in_value); // Assigns key / value pair to hash map at the tail of doubly linked list without making copies -int iscsi_hashmap_put_free(iscsi_hashmap *map, uint8_t *key, const size_t key_size, uint8_t *value, iscsi_hashmap_callback callback, uint8_t *user_data); // Assigns key / value pair to hash map without making copies with callback function in case the key already exists -bool iscsi_hashmap_contains(iscsi_hashmap *map, const uint8_t *key, const size_t key_size); // Checks whether a specified key exists -int iscsi_hashmap_get(iscsi_hashmap *map, const uint8_t *key, const size_t key_size, uint8_t **out_value); // Retrieves the value of a specified key - -void iscsi_hashmap_remove(iscsi_hashmap *map, const uint8_t *key, const size_t key_size); // Removes an element both from the doubly linked list and by setting the key to NULL -void iscsi_hashmap_remove_free(iscsi_hashmap *map, const uint8_t *key, const size_t key_size, iscsi_hashmap_callback callback, uint8_t *user_data); // Removes an element both from the doubly linked list and by setting the key to NULL and invokes a callback function before actual removal - -uint iscsi_hashmap_size(const iscsi_hashmap *map); // Retrieves the number of elements of the hash map - -int iscsi_hashmap_iterate(iscsi_hashmap *map, iscsi_hashmap_callback callback, uint8_t *user_data); // Iterator with callback function invoked on each element +#define ISCSI_STRLEN(x) ((sizeof(x) / sizeof(uint8_t)) - 1) /* iSCSI protocol stuff (all WORD/DWORD/QWORD values are big endian by default @@ -805,7 +304,7 @@ int iscsi_hashmap_iterate(iscsi_hashmap *map, iscsi_hashmap_callback callback, u #define ISCSI_MAX_AHS_SIZE (255UL << 2UL) /// iSCSI DataSegment maximum allowed size. -#define ISCSI_MAX_DS_SIZE 16777215UL +#define ISCSI_MAX_DS_SIZE 16777215 /// iSCSI packet data alignment (BHS, AHS and DataSegment). #define ISCSI_ALIGN_SIZE 4UL @@ -815,10 +314,10 @@ int iscsi_hashmap_iterate(iscsi_hashmap *map, iscsi_hashmap_callback callback, u /// iSCSI Default receive DataSegment (DS) size in bytes. -#define ISCSI_DEFAULT_RECV_DS_LEN 8192UL +#define ISCSI_DEFAULT_RECV_DS_LEN 131072UL /// iSCSI default maximum DataSegment receive length in bytes. -#define ISCSI_DEFAULT_MAX_RECV_DS_LEN 65536UL +#define ISCSI_DEFAULT_MAX_RECV_DS_LEN 524288UL /// iSCSI default maximum Ready To Transfer (R2T) active tasks. @@ -941,6 +440,7 @@ int iscsi_hashmap_iterate(iscsi_hashmap *map, iscsi_hashmap_callback callback, u /// iSCSI opcode flags (I) Immediate bit: For Request PDUs, the I bit set to 1 is an immediate delivery marker. #define ISCSI_OPCODE_FLAGS_IMMEDIATE (1 << 6L) +#define ASSERT_IS_BHS(structname) _Static_assert( sizeof(structname) == ISCSI_BHS_SIZE, #structname " messed up" ) /** * @brief iSCSI Basic Header Segment packet data. @@ -951,32 +451,34 @@ int iscsi_hashmap_iterate(iscsi_hashmap *map, iscsi_hashmap_callback callback, u * has been determined. */ typedef struct __attribute__((packed)) iscsi_bhs_packet { - /// Command opcode. - uint8_t opcode; + /// Command opcode. + uint8_t opcode; - /// Opcode-specific fields. - uint8_t opcode_fields[3]; + /// Opcode-specific fields. + uint8_t opcode_fields[3]; - /// Total length of AHS (Advanced Header Segment). - uint8_t total_ahs_len; + /// Total length of AHS (Advanced Header Segment). + uint8_t total_ahs_len; - /// Length of Data Segment. - uint8_t ds_len[3]; + /// Length of Data Segment. + uint8_t ds_len[3]; - union { - /// SCSI LUN bit mask. - uint64_t lun; + union { + /// SCSI LUN bit mask. + uint64_t lun; - /// Opcode-specific fields. - uint8_t opcode_spec[8]; - } lun_opcode; + /// Opcode-specific fields. + uint8_t opcode_spec[8]; + } lun_opcode; - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; - /// Opcode-specific fields. - uint8_t opcode_spec_fields[28]; + /// Opcode-specific fields. + uint8_t opcode_spec_fields[28]; } iscsi_bhs_packet; +ASSERT_IS_BHS( iscsi_bhs_packet ); + /// iSCSI AHS type: Extended Command Descriptor Block (CDB). @@ -995,61 +497,19 @@ typedef struct __attribute__((packed)) iscsi_bhs_packet { * has been determined. */ typedef struct __attribute__((packed)) iscsi_ahs_packet { - /// AHSLength. - uint16_t len; + /// AHSLength. + uint16_t len; - /// AHSType. - uint8_t type; + /// AHSType. + uint8_t type; - /// AHS-Specific. - uint8_t specific; + /// AHS-Specific. + uint8_t specific; - /// AHS-Specific data. - uint8_t data[0]; + /// AHS-Specific data. + uint8_t data[0]; } iscsi_ahs_packet; - -/** - * @brief iSCSI Extended CDB AHS packet data structure. - * - * This type of AHS MUST NOT be used if the CDBLength is less than 17. - * The length includes the reserved byte 3. - */ -typedef struct __attribute__((packed)) iscsi_ext_cdb_ahs_packet { - /// AHSLength: AHSLength - (CDBLength - 15). - uint16_t len; - - // AHSType: Identifier (always 1 according to iSCSI specifications). - uint8_t type; - - /// Reserved for future usage, always MUST be 0. - uint8_t reserved; - - /// ExtendedCDB. - uint8_t data[0]; -} iscsi_ext_cdb_ahs_packet; - -/** - * @brief iSCSI Bidirectional Read Expected Data Transfer Length AHS packet data structure. - * - * This structure is used to determine the bidirectional read - * expected data transfer length. - */ -typedef struct __attribute__((packed)) iscsi_bidi_read_exp_xfer_ahs_packet { - /// AHSLength: Always 5 according to iSCSI specifications for now. - uint16_t len; - - /// AHSType: Always 2 according to iSCSI specifications for now. - uint8_t type; // Identifier (always 0x02 according to specs) - - /// Reserved for future usage, always MUST be 0. - uint8_t reserved; - - /// Bidirectional Read Expected Data Transfer Length. - uint32_t bidi_read_exp_xfer_len; -} iscsi_bidi_read_exp_xfer_ahs_packet; - - /** * @brief DataSegment Error: Unexpected unsolicited data. * @@ -1091,84 +551,6 @@ typedef struct __attribute__((packed)) iscsi_bidi_read_exp_xfer_ahs_packet { */ #define ISCSI_DS_ERROR_INCORRECT_AMOUNT_OF_DATA_ASCQ 0x0D - -/** - * @brief DataSegment Error: Protocol Service CRC error. - * - * Certain iSCSI conditions result in the command being terminated at - * the target (response code of Command Completed at Target) with a SCSI - * CHECK CONDITION Status as outlined in the following definitions - * (Sense key: Aborted Command 0x0B). - */ -#define ISCSI_DS_ERROR_PROTOCOL_SERVICE_CRC_ERROR_ASC 0x47 - -/** - * @brief DataSegment Error: Protocol Service CRC error. - * - * Certain iSCSI conditions result in the command being terminated at - * the target (response code of Command Completed at Target) with a SCSI - * CHECK CONDITION Status as outlined in the following definitions - * (Sense key: Aborted Command 0x0B). - */ -#define ISCSI_DS_ERROR_PROTOCOL_SERVICE_CRC_ERROR_ASCQ 0x05 - - -/** - * @brief DataSegment Error: Selective Negative / Sequence Number Acknowledgment (SNACK) rejected. - * - * Certain iSCSI conditions result in the command being terminated at - * the target (response code of Command Completed at Target) with a SCSI - * CHECK CONDITION Status as outlined in the following definitions - * (Sense key: Aborted Command 0x0B). - */ -#define ISCSI_DS_ERROR_SNACK_REJECTED_ASC 0x11 - -/** - * @brief DataSegment Error: Selective Negative / Sequence Number Acknowledgment (SNACK) rejected. - * - * Certain iSCSI conditions result in the command being terminated at - * the target (response code of Command Completed at Target) with a SCSI - * CHECK CONDITION Status as outlined in the following definitions - * (Sense key: Aborted Command 0x0B). - */ -#define ISCSI_DS_ERROR_SNACK_REJECTED_ASCQ 0x13 - - -/** - * @brief iSCSI header digest in case CRC32C has been negotiated. - * - * Optional header and data digests protect the integrity of the header - * and data, respectively. The digests, if present, are located, - * respectively, after the header and PDU-specific data and cover, - * respectively, the header and the PDU data, each including the padding - * bytes, if any. - * - * The existence and type of digests are negotiated during the Login - * Phase. - */ -typedef struct __attribute__((packed)) iscsi_header_digest { - /// Header digest is a CRC32C for ensuring integrity. - uint32_t crc32c; -} iscsi_header_digest; - -/** - * @brief iSCSI data digest in case CRC32C has been negotiated. - * - * Optional header and data digests protect the integrity of the header - * and data, respectively. The digests, if present, are located, - * respectively, after the header and PDU-specific data and cover, - * respectively, the header and the PDU data, each including the padding - * bytes, if any. - * - * The existence and type of digests are negotiated during the Login - * Phase. - */ -typedef struct __attribute__((packed)) iscsi_data_digest { - /// Data digest is a CRC32C for ensuring integrity. - uint32_t crc32c; -} iscsi_data_digest; - - /** * @brief iSCSI SCSI CDB packet data structure. * @@ -1177,11 +559,11 @@ typedef struct __attribute__((packed)) iscsi_data_digest { * MUST be used to contain the CDB spillover. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb { - /// SCSI opcode. - uint8_t opcode; + /// SCSI opcode. + uint8_t opcode; - /// Additional op-code specific data. - uint8_t data[0]; + /// Additional op-code specific data. + uint8_t data[0]; } iscsi_scsi_cdb; @@ -1198,20 +580,20 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb { * There are 6 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_inquiry { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Logical Unit Number (LUN), CMMDT and EVPD. - uint8_t lun_flags; + /// Logical Unit Number (LUN), CMMDT and EVPD. + uint8_t lun_flags; - /// Page code. - uint8_t page_code; + /// Page code. + uint8_t page_code; - /// Allocation length in bytes. - uint16_t alloc_len; + /// Allocation length in bytes. + uint16_t alloc_len; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_inquiry; @@ -1221,17 +603,17 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_inquiry { * There are 6 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_6 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Logical Block Address (LBA). - uint8_t lba[3]; + /// Logical Block Address (LBA). + uint8_t lba[3]; - /// Transfer length in bytes. - uint8_t xfer_len; + /// Transfer length in bytes. + uint8_t xfer_len; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_read_write_6; @@ -1241,23 +623,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_6 { * There are 10 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_10 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Logical Block Address (LBA). - uint32_t lba; + /// Logical Block Address (LBA). + uint32_t lba; - /// Group number. - int8_t group_num; + /// Group number. + int8_t group_num; - /// Transfer length in bytes. - uint16_t xfer_len; + /// Transfer length in bytes. + uint16_t xfer_len; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_read_write_10; @@ -1267,23 +649,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_10 { * There are 12 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_12 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Logical Block Address (LBA). - uint32_t lba; + /// Logical Block Address (LBA). + uint32_t lba; - /// Transfer length in bytes. - uint32_t xfer_len; + /// Transfer length in bytes. + uint32_t xfer_len; - /// Restricted for MMC-6 and group number. - int8_t restrict_group_num; + /// Restricted for MMC-6 and group number. + int8_t restrict_group_num; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_read_write_12; @@ -1293,23 +675,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_12 { * There are 16 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_16 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Logical Block Address (LBA). - uint64_t lba; + /// Logical Block Address (LBA). + uint64_t lba; - /// Transfer length in bytes. - uint32_t xfer_len; + /// Transfer length in bytes. + uint32_t xfer_len; - /// Restricted for MMC-6 and group number. - int8_t restrict_group_num; + /// Restricted for MMC-6 and group number. + int8_t restrict_group_num; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_read_write_16; @@ -1329,86 +711,32 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_read_write_16 { * There are 12 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_report_luns { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Select report. - uint8_t select_report; + /// Select report. + uint8_t select_report; - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved2; + /// Reserved for future usage (always MUST be 0 for now). + uint16_t reserved2; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved3; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved3; - /// Allocation length in bytes. - uint32_t alloc_len; + /// Allocation length in bytes. + uint32_t alloc_len; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved4; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved4; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_report_luns; -/// iSCSI SCSI Command Descriptor Block (CDB) for COMPARE AND WRITE command flags: Force Unit Access (FUA). -#define ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_FUA (1 << 3L) - -/// iSCSI SCSI Command Descriptor Block (CDB) for COMPARE AND WRITE command flags: Disable Page Out (DPO). -#define ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_DPO (1 << 4L) - -/// iSCSI SCSI Command Descriptor Block (CDB) for COMPARE AND WRITE command write protect flags: First bit of the three bits. -#define ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_FIRST_BIT 5 - -/// iSCSI SCSI Command Descriptor Block (CDB) for COMPARE AND WRITE command write protect flags: Last bit of the three bits. -#define ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_LAST_BIT ((ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_FIRST_BIT) + 3 - 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for COMPARE AND WRITE command write protect flags: Bit mask. -#define ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_FIRST_BIT, ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for COMPARE AND WRITE command write protect flags: Extracts the write protect bits. -#define ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_GET_WRPROTECT(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_FIRST_BIT, ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for COMPARE AND WRITE command write protect flags: Stores into the write protect bits. -#define ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_PUT_WRPROTECT(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_FIRST_BIT, ISCSI_SCSI_CDB_CMP_WRITE_FLAGS_WRPROTECT_LAST_BIT)) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI COMPARE AND WRITE command. - * - * There are 16 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_cmp_write { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Logical Block Address (LBA). - uint64_t lba; - - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; - - /// Number of blocks in bytes. - uint8_t num_blocks; - - /// Restricted for MMC-6 and group number. - int8_t restrict_group_num; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_cmp_write; - - /// iSCSI SCSI Command Descriptor Block (CDB) for SERVICE ACTION IN(16) command service action: READ CAPACITY(16). #define ISCSI_SCSI_CDB_SERVICE_ACTION_IN_16_ACTION_READ_CAPACITY_16 0x10 @@ -1437,196 +765,26 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_cmp_write { * There are 16 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_service_action_in_16 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Service action. - uint8_t action; + /// Service action. + uint8_t action; - /// Logical Block Address (LBA), obselete by now. - uint64_t lba; + /// Logical Block Address (LBA), obselete by now. + uint64_t lba; - /// Allocation length in bytes. - uint32_t alloc_len; + /// Allocation length in bytes. + uint32_t alloc_len; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_service_action_in_16; -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI SYNCHRONIZE CACHE(10) command. - * - * There are 10 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_sync_cache_10 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Logical Block Address (LBA). - uint32_t lba; - - /// Group number. - int8_t group_num; - - /// Transfer length in bytes. - uint16_t xfer_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_sync_cache_10; - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI SYNCHRONIZE CACHE(16) command. - * - * There are 16 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_sync_cache_16 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Logical Block Address (LBA). - uint64_t lba; - - /// Transfer length in bytes. - uint32_t xfer_len; - - /// Group number. - int8_t group_num; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_sync_cache_16; - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI WRITE SAME(10) command. - * - * There are 10 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_write_same_10 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Logical Block Address (LBA). - uint32_t lba; - - /// Group number. - int8_t group_num; - - /// Transfer length in bytes. - uint16_t xfer_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_write_same_10; - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI WRITE SAME(16) command. - * - * There are 16 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_write_same_16 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Logical Block Address (LBA). - uint64_t lba; - - /// Transfer length in bytes. - uint32_t xfer_len; - - /// Group number. - int8_t group_num; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_write_same_16; - - -/// iSCSI SCSI Command Descriptor Block (CDB) for MODE SELECT(6) command flags: Save Pages (SP). -#define ISCSI_SCSI_CDB_MODE_SELECT_6_FLAGS_SP (1 << 0) - -/// iSCSI SCSI Command Descriptor Block (CDB) for MODE SELECT(6) command flags: Revert To Defaults (RTD). -#define ISCSI_SCSI_CDB_MODE_SELECT_6_FLAGS_RTD (1 << 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for MODE SELECT(6) command flags: Page Format (PF). -#define ISCSI_SCSI_CDB_MODE_SELECT_6_FLAGS_PF (1 << 4) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI MODE SELECT(6) command. - * - * There are 6 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_mode_select_6 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; - - /// Parameter list length in bytes. - uint8_t param_list_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_mode_select_6; - - -/// iSCSI SCSI Command Descriptor Block (CDB) for MODE SELECT(10) command flags: Save Pages (SP). -#define ISCSI_SCSI_CDB_MODE_SELECT_10_FLAGS_SP (1 << 0) - -/// iSCSI SCSI Command Descriptor Block (CDB) for MODE SELECT(10) command flags: Page Format (PF). -#define ISCSI_SCSI_CDB_MODE_SELECT_10_FLAGS_PF (1 << 4) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI MODE SELECT(10) command. - * - * There are 10 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_mode_select_10 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Reserved for future usage (always MUST be 0 for now). - uint32_t reserved; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; - - /// Parameter list length in bytes. - uint16_t param_list_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_mode_select_10; - - /// iSCSI SCSI Command Descriptor Block (CDB) for MODE SENSE(6) command flags: Disable Block Descriptors (DBD). #define ISCSI_SCSI_CDB_MODE_SENSE_6_FLAGS_DBD (1 << 3) @@ -1680,23 +838,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_mode_select_10 { * There are 6 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_mode_sense_6 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Page code and page control. - uint8_t page_code_control; + /// Page code and page control. + uint8_t page_code_control; - /// Sub page code. - uint8_t sub_page_code; + /// Sub page code. + uint8_t sub_page_code; - /// Allocation length in bytes. - uint8_t alloc_len; + /// Allocation length in bytes. + uint8_t alloc_len; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_mode_sense_6; @@ -1756,437 +914,32 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_mode_sense_6 { * There are 10 bytes in the CDB field for this command. */ typedef struct __attribute__((packed)) iscsi_scsi_cdb_mode_sense_10 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; + /// SCSI opcode. + iscsi_scsi_cdb cdb; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Page code and page control. - uint8_t page_code_control; + /// Page code and page control. + uint8_t page_code_control; - /// Sub page code. - uint8_t sub_page_code; + /// Sub page code. + uint8_t sub_page_code; - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint16_t reserved; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved2; - /// Allocation length in bytes. - uint16_t alloc_len; + /// Allocation length in bytes. + uint16_t alloc_len; - /// Control. - uint8_t control; + /// Control. + uint8_t control; } iscsi_scsi_cdb_mode_sense_10; -/// iSCSI SCSI Command Descriptor Block (CDB) for REQUEST SENSE command flags: Descriptor Format (DESC). -#define ISCSI_SCSI_CDB_REQ_SENSE_FLAGS_DESC (1 << 0) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI REQUEST SENSE command. - * - * There are 6 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_req_sense { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; - - /// Allocation length in bytes. - uint8_t alloc_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_req_sense; - - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags: Reply immediately after CDB check (IMMED). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_EXEC_FLAGS_IMMED (1 << 0) - - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Process the START and LOEJ bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_PROC_START_LOEJ_BITS 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Cause the logical unit to transition to the active power condition (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_ACTIVE 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Cause the logical unit to transition to the idle_a power condition (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_IDLE_A 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Cause the logical unit to transition to the idle_b power condition (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_IDLE_B 0x1 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Cause the logical unit to transition to the idle_c power condition (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_IDLE_C 0x2 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Cause the logical unit to transition to the standby_z power condition (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_STANDBY_Z 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Cause the logical unit to transition to the standby_b power condition (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_STANDBY_Y 0x1 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Initialize and start all of the idle and standby condition timers that are enabled (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_LU_CONTROL 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Force the idle_a condition timer to be set to zero (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FORCE_IDLE_A_0 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Force the idle_b condition timer to be set to zero (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FORCE_IDLE_B_0 0x1 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Force the idle_c condition timer to be set to zero (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FORCE_IDLE_C_0 0x2 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Force the standby_z condition timer to be set to zero (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FORCE_STANDBY_Z_0 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Force the standby_y condition timer to be set to zero (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FORCE_STANDBY_Y_0 0x1 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: First bit of the four bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FIRST_BIT 0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Last bit of the four bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_LAST_BIT ((ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FIRST_BIT) + 4 - 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Bit mask. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FIRST_BIT, ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Extracts the power condition modifier bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_GET_POWER_COND_MOD(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FIRST_BIT, ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution power condition modifier: Stores into the power condition modifier bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_PUT_POWER_COND_MOD(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_FIRST_BIT, ISCSI_SCSI_CDB_START_STOP_UNIT_POWER_COND_MOD_LAST_BIT)) - - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags: START. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_START (1 << 0) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags: LOad EJect (LOEJ). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_LOEJ (1 << 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags: Do not flush caches until a power condition that prevents accessing the medium is entered (NO_FLUSH). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_NO_FLUSH (1 << 2) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Process the START and LOEJ bits (START_VALID). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_START_VALID 0x0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Cause the logical unit to transition to the active power condition (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_ACTIVE 0x1 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Cause the logical unit to transition to the idle_a to idle_c power conditions (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_IDLE 0x2 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Cause the logical unit to transition to the standby_z and standby_y power conditions (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_STANDBY 0x3 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Obselete. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_OBSELETE 0x5 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Initialize and start all of the idle and standby condition timers that are enabled (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_LU_CONTROL 0x7 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Force the idle_a to idle_c condition timers to be set to zero (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_FORCE_IDLE_0 0xA - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Force the standby_z and standby_y condition timers to be set to zero (see SPC5). -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_FORCE_STANDBY_0 0xB - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: First bit of the four bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_FIRST_BIT 4 - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Last bit of the four bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_LAST_BIT ((ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_FIRST_BIT) + 8 - 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Bit mask. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_FIRST_BIT, ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Extracts the power condition bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_GET_POWER_COND(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_FIRST_BIT, ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for START STOP UNIT command execution flags power condition: Stores into the power condition bits. -#define ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_PUT_POWER_COND(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_FIRST_BIT, ISCSI_SCSI_CDB_START_STOP_UNIT_FLAGS_POWER_COND_LAST_BIT)) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI START STOP UNIT command. - * - * There are 6 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_start_stop_unit { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Execution flags. - int8_t exec_flags; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; - - /// Power condition modifier. - uint8_t power_cond_mod; - - /// Flags. - int8_t flags; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_start_stop_unit; - - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Register - Register a reservation key without making a reservation. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_REGISTER 0x00 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Reserve - Create a persistent reservation of the specified scope and type. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_RESERVE 0x01 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Release - Releases the selected reservation for the requesting initiator. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_RELEASE 0x02 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Clear – Clears all reservations keys and all persistent reservations. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_CLEAR 0x03 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Preempt – Preempt reservations from another initiator. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_PREEMPT 0x04 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Preempt reservations from another initiator and abort all tasks for all initiators with the specified reservation key. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_PREEMPT_ABORT 0x05 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Register and Ignore Existing Key – Register a new reservation key and discard existing reservation key. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_REGISTER_IGNORE_EXIST_KEY 0x06 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Register and Move Registers - Registers a reservation key for another I_T nexus and moves the persistent reservation to that I-T nexus. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_REGISTER_MOVE_REGS 0x07 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: First bit of the five bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_FIRST_BIT 0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Last bit of the five bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_LAST_BIT ((ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_FIRST_BIT) + 5 - 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Bit mask. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_FIRST_BIT, ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Extracts the service action bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_GET_ACTION(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_FIRST_BIT, ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE OUT command service action: Stores into the service action bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_OUT_PUT_ACTION(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_FIRST_BIT, ISCSI_SCSI_CDB_PR_RESERVE_OUT_ACTION_LAST_BIT)) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI PERSISTENT RESERVE OUT command. - * - * There are 10 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_pr_reserve_out { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Service action. - uint8_t action; - - /// Scope and reservation type. - uint8_t scope_type; - - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; - - /// Parameter list length in bytes. - uint32_t param_list_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_pr_reserve_out; - - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Read keys - Reads all registered reservation keys (i.e. registrations) as described in SPC5. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_READ_KEYS 0x00 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Read reservations - Reads the current persistent reservations as described in SPC5. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_READ_RESERVATIONS 0x01 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Report capabilities - Returns capability information. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_READ_REPORT_CAPABILITIES 0x02 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Read full status – Reads complete information about all registrations and the persistent reservations, if any. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_READ_FULL_STATUS 0x03 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: First bit of the five bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_FIRST_BIT 0 - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Last bit of the five bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_LAST_BIT ((ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_FIRST_BIT) + 5 - 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Bit mask. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_FIRST_BIT, ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Extracts the service action bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_GET_ACTION(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_FIRST_BIT, ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_LAST_BIT)) - -/// iSCSI SCSI Command Descriptor Block (CDB) for PERSISTENT RESERVE IN command service action: Stores into the service action bits. -#define ISCSI_SCSI_CDB_PR_RESERVE_IN_PUT_ACTION(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_FIRST_BIT, ISCSI_SCSI_CDB_PR_RESERVE_IN_ACTION_LAST_BIT)) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI PERSISTENT RESERVE IN command. - * - * There are 10 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_pr_reserve_in { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Service action. - uint8_t action; - - /// Reserved for future usage (always MUST be 0 for now). - uint32_t reserved; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; - - /// Parameter list length in bytes. - uint16_t param_list_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_pr_reserve_in; - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI RESERVE(6) command. - * - * There are 6 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_pr_reserve_6 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved_obselete; - - /// Obselete byte. - uint8_t obselete; - - /// Obselete word. - uint16_t obselete2; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_pr_reserve_6; - - -/// iSCSI SCSI Command Descriptor Block (CDB) for RESERVE(10) command flags: Long identifier larger than 255 (LONGID). -#define ISCSI_SCSI_CDB_RESERVE_10_FLAGS_LONGID (1 << 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for RESERVE(10) command flags: Third-party reservation (3RDPTY). -#define ISCSI_SCSI_CDB_RESERVE_10_FLAGS_3RDPTY (1 << 4) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI RESERVE(10) command. - * - * There are 10 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_pr_reserve_10 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Obselete. - uint8_t obselete; - - /// Third-party device identifier. - uint8_t third_party_dev_id; - - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; - - /// Parameter list length in bytes. - uint16_t param_list_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_pr_reserve_10; - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI RELEASE(6) command. - * - * There are 6 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_pr_release_6 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved_obselete; - - /// Obselete byte. - uint8_t obselete; - - /// Obselete word. - uint16_t obselete2; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_pr_release_6; - - -/// iSCSI SCSI Command Descriptor Block (CDB) for RELEASE(10) command flags: Long identifier larger than 255 (LONGID). -#define ISCSI_SCSI_CDB_RELEASE_10_FLAGS_LONGID (1 << 1) - -/// iSCSI SCSI Command Descriptor Block (CDB) for RELEASE(10) command flags: Third-party reservation (3RDPTY). -#define ISCSI_SCSI_CDB_RELEASE_10_FLAGS_3RDPTY (1 << 4) - - -/** - * @brief iSCSI SCSI CDB packet data structure for SCSI RELEASE(10) command. - * - * There are 10 bytes in the CDB field for this command. - */ -typedef struct __attribute__((packed)) iscsi_scsi_cdb_pr_release_10 { - /// SCSI opcode. - iscsi_scsi_cdb cdb; - - /// Flags. - int8_t flags; - - /// Obselete. - uint8_t obselete; - - /// Third-party device identifier. - uint8_t third_party_dev_id; - - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; - - /// Parameter list length in bytes. - uint16_t param_list_len; - - /// Control. - uint8_t control; -} iscsi_scsi_cdb_pr_release_10; - - /** * @brief iSCSI SCSI DataSegment Command packet structure. * @@ -2199,14 +952,14 @@ typedef struct __attribute__((packed)) iscsi_scsi_cdb_pr_release_10 { * contain a vendor-specific detailed description of the failure). */ typedef struct __attribute__((packed)) iscsi_scsi_ds_cmd_data { - /// SenseLength: This field indicates the length of Sense Data. - uint16_t len; + /// SenseLength: This field indicates the length of Sense Data. + uint16_t len; - /// The Sense Data contains detailed information about a CHECK CONDITION. SPC3 specifies the format and content of the Sense Data. - uint8_t sense_data[0]; + /// The Sense Data contains detailed information about a CHECK CONDITION. SPC3 specifies the format and content of the Sense Data. + uint8_t sense_data[0]; - /// Response Data. - uint8_t res_data[0]; + /// Response Data. + uint8_t res_data[0]; } iscsi_scsi_ds_cmd_data; @@ -2414,20 +1167,20 @@ typedef struct __attribute__((packed)) iscsi_scsi_ds_cmd_data { * cleared. */ typedef struct __attribute__((packed)) iscsi_scsi_basic_inquiry_data_packet { - /// Peripheral device type and qualifier. - uint8_t peripheral_type_id; + /// Peripheral device type and qualifier. + uint8_t peripheral_type_id; - /// Peripheral device type modifier and removable media bit. - int8_t peripheral_type_mod_flags; + /// Peripheral device type modifier and removable media bit. + int8_t peripheral_type_mod_flags; - /// ANSI-Approved, ECMA and ISO version. - uint8_t version; + /// ANSI-Approved, ECMA and ISO version. + uint8_t version; - /// Response data format, HISUP, NORMACA, AENC and TrmIOP flags. - int8_t response_data_fmt_flags; + /// Response data format, HISUP, NORMACA, AENC and TrmIOP flags. + int8_t response_data_fmt_flags; - /// Additional length in bytes. - uint8_t add_len; + /// Additional length in bytes. + uint8_t add_len; } iscsi_scsi_basic_inquiry_data_packet; @@ -2503,26 +1256,26 @@ typedef struct __attribute__((packed)) iscsi_scsi_basic_inquiry_data_packet { * cleared. */ typedef struct __attribute__((packed)) iscsi_scsi_std_inquiry_data_packet { - /// iSCSI SCSI basic inquiry data packet. - iscsi_scsi_basic_inquiry_data_packet basic_inquiry; + /// iSCSI SCSI basic inquiry data packet. + iscsi_scsi_basic_inquiry_data_packet basic_inquiry; - /// PROTECT, 3PC, TPGS, ACC and SCCS. - uint8_t tpgs_flags; + /// PROTECT, 3PC, TPGS, ACC and SCCS. + uint8_t tpgs_flags; - /// MULTIP, VS and ENCSERV. - int8_t services_flags; + /// MULTIP, VS and ENCSERV. + int8_t services_flags; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Vendor identification. - uint8_t vendor_id[8]; + /// Vendor identification. + uint8_t vendor_id[8]; - /// Product identification. - uint8_t product_id[16]; + /// Product identification. + uint8_t product_id[16]; - /// Product revision level. - uint8_t product_rev_level[4]; + /// Product revision level. + uint8_t product_rev_level[4]; } iscsi_scsi_std_inquiry_data_packet; @@ -2551,29 +1304,29 @@ typedef struct __attribute__((packed)) iscsi_scsi_std_inquiry_data_packet { * cleared. */ typedef struct __attribute__((packed)) iscsi_scsi_ext_inquiry_data_packet { - /// iSCSI SCSI standard inquiry data packet. - iscsi_scsi_std_inquiry_data_packet std_inquiry; + /// iSCSI SCSI standard inquiry data packet. + iscsi_scsi_std_inquiry_data_packet std_inquiry; - /// Vendor specific. - uint8_t vendor_spec[20]; + /// Vendor specific. + uint8_t vendor_spec[20]; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0). + uint8_t reserved; - /// Version descriptors. - uint16_t version_desc[8]; + /// Version descriptors. + uint16_t version_desc[8]; - /// Reserved for future usage (always MUST be 0). - uint64_t reserved2[2]; + /// Reserved for future usage (always MUST be 0). + uint64_t reserved2[2]; - /// Reserved for future usage (always MUST be 0). - uint32_t reserved3; + /// Reserved for future usage (always MUST be 0). + uint32_t reserved3; - /// Reserved for future usage (always MUST be 0). - uint16_t reserved4; + /// Reserved for future usage (always MUST be 0). + uint16_t reserved4; } iscsi_scsi_ext_inquiry_data_packet; @@ -2699,17 +1452,17 @@ typedef struct __attribute__((packed)) iscsi_scsi_ext_inquiry_data_packet { * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_inquiry_data_packet { - /// Peripheral device type and qualifier. - uint8_t peripheral_type_id; + /// Peripheral device type and qualifier. + uint8_t peripheral_type_id; - /// Page code. - uint8_t page_code; + /// Page code. + uint8_t page_code; - /// Allocation length in bytes. - uint16_t alloc_len; + /// Allocation length in bytes. + uint16_t alloc_len; - /// Parameters. - uint8_t params[0]; + /// Parameters. + uint8_t params[0]; } iscsi_scsi_vpd_page_inquiry_data_packet; @@ -2834,20 +1587,20 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_inquiry_data_packet { * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_inquiry_data_packet { - /// Protocol identifier and code set. - uint8_t protocol_id_code_set; + /// Protocol identifier and code set. + uint8_t protocol_id_code_set; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0). + uint8_t reserved; - /// Length in bytes. - uint8_t len; + /// Length in bytes. + uint8_t len; - /// Designation descriptor. - uint8_t desc[0]; + /// Designation descriptor. + uint8_t desc[0]; } iscsi_scsi_vpd_page_design_desc_inquiry_data_packet; @@ -2859,8 +1612,8 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_inquiry_d * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_ieee_naa_ext_inquiry_data_packet { - /// IEEE NAA Extended. - uint64_t ieee_naa_ext; + /// IEEE NAA Extended. + uint64_t ieee_naa_ext; } iscsi_scsi_vpd_page_design_desc_ieee_naa_ext_inquiry_data_packet; @@ -2872,14 +1625,14 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_ieee_naa_ * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_t10_vendor_id_inquiry_data_packet { - /// Vendor identification. - uint8_t vendor_id[8]; + /// Vendor identification. + uint8_t vendor_id[8]; - /// Product identification. - uint8_t product_id[16]; + /// Product identification. + uint8_t product_id[16]; - /// Unit serial number. - uint8_t unit_serial_num[32]; + /// Unit serial number. + uint8_t unit_serial_num[32]; } iscsi_scsi_vpd_page_design_desc_t10_vendor_id_inquiry_data_packet; @@ -2891,11 +1644,11 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_t10_vendo * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_rel_target_port_inquiry_data_packet { - /// Reserved for future usage (always MUST be 0). - uint16_t reserved; + /// Reserved for future usage (always MUST be 0). + uint16_t reserved; - /// Port index. - uint16_t index; + /// Port index. + uint16_t index; } iscsi_scsi_vpd_page_design_desc_rel_target_port_inquiry_data_packet; @@ -2907,11 +1660,11 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_rel_targe * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_target_port_group_inquiry_data_packet { - /// Reserved for future usage (always MUST be 0). - uint16_t reserved; + /// Reserved for future usage (always MUST be 0). + uint16_t reserved; - /// Port group index. - uint16_t index; + /// Port group index. + uint16_t index; } iscsi_scsi_vpd_page_design_desc_target_port_group_inquiry_data_packet; @@ -2923,11 +1676,11 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_target_po * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_logical_unit_group_inquiry_data_packet { - /// Reserved for future usage (always MUST be 0). - uint16_t reserved; + /// Reserved for future usage (always MUST be 0). + uint16_t reserved; - /// Logical unit identifier. - uint16_t id; + /// Logical unit identifier. + uint16_t id; } iscsi_scsi_vpd_page_design_desc_logical_unit_group_inquiry_data_packet; @@ -3075,296 +1828,47 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_design_desc_logical_u * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_ext_inquiry_data_packet { - /// Peripheral device type and qualifier. - uint8_t peripheral_type_id; + /// Peripheral device type and qualifier. + uint8_t peripheral_type_id; - /// Page code. - uint8_t page_code; + /// Page code. + uint8_t page_code; - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0). + uint8_t reserved; - /// Page length in bytes. - uint8_t page_len; + /// Page length in bytes. + uint8_t page_len; - /// Check flags. - int8_t check_flags; + /// Check flags. + int8_t check_flags; - /// Support flags. - int8_t support_flags; + /// Support flags. + int8_t support_flags; - /// More support flags. - int8_t support_flags_2; + /// More support flags. + int8_t support_flags_2; - /// LUICLR. - uint8_t luiclr; + /// LUICLR. + uint8_t luiclr; - /// CBCS. - uint8_t cbcs; + /// CBCS. + uint8_t cbcs; - /// Micro DL. - uint8_t micro_dl; + /// Micro DL. + uint8_t micro_dl; - /// Reserved for future usage (always MUST be 0). - uint64_t reserved2[6]; + /// Reserved for future usage (always MUST be 0). + uint64_t reserved2[6]; - /// Reserved for future usage (always MUST be 0). - uint32_t reserved3; + /// Reserved for future usage (always MUST be 0). + uint32_t reserved3; - /// Reserved for future usage (always MUST be 0). - uint16_t reserved4; + /// Reserved for future usage (always MUST be 0). + uint16_t reserved4; } iscsi_scsi_vpd_page_ext_inquiry_data_packet; -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data policy page code: First bit of the six bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_FIRST_BIT 0 - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data policy page code: Last bit of the six bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_LAST_BIT ((ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_FIRST_BIT) + 6 - 1) - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data policy page code: Bit mask. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_FIRST_BIT, ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data policy page code: Extracts the policy page code bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_GET_POLICY_PAGE_CODE(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_FIRST_BIT, ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data policy page code: Stores into the policy page code bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_PUT_POLICY_PAGE_CODE(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_FIRST_BIT, ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_POLICY_PAGE_CODE_LAST_BIT)) - - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data flags mode page policy: First bit of the two bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_FIRST_BIT 0 - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data flags mode page policy: Last bit of the two bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_LAST_BIT ((ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_FIRST_BIT) + 2 - 1) - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data flags mode page policy: Bit mask. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_FIRST_BIT, ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data flags mode page policy: Extracts the mode page policy bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_GET_MODE_PAGE_POLICY(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_FIRST_BIT, ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data flags mode page policy: Stores into the mode page policy bits. -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_PUT_MODE_PAGE_POLICY(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_FIRST_BIT, ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MODE_PAGE_POLICY_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry Data flag: Multiple Logical Units Share (MLUS). -#define ISCSI_SCSI_VPD_MODE_PAGE_POLICY_DESC_INQUIRY_DATA_FLAGS_MLUS (1 << 7) - - -/** - * @brief iSCSI SCSI Vital Product Data (VPD) Mode Page Policy Descriptor Inquiry data packet. - * - * This structure is used by the SCSI INQUIRY command - * in order to fill in the result if the EVPD bit is - * set. - */ -typedef struct __attribute__((packed)) iscsi_scsi_vpd_mode_page_policy_desc_inquiry_data_packet { - /// Policy page code. - uint8_t page_code; - - /// Policy sub page code. - uint8_t sub_page_code; - - /// Policy flags. - int8_t flags; - - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; -} iscsi_scsi_vpd_mode_page_policy_desc_inquiry_data_packet; - - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data protocol identifier: iSCSI. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_ISCSI 0x05 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data protocol identifier: First bit of the four bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_FIRST_BIT 0 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data protocol identifier: Last bit of the four bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_LAST_BIT ((ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_FIRST_BIT) + 4 - 1) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data protocol identifier: Bit mask. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data protocol identifier: Extracts the protocol identifier bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_GET_PROTOCOL_ID(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data protocol identifier: Stores into the protocol identifier bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PUT_PROTOCOL_ID(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PROTOCOL_ID_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: Binary encoding. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_BINARY 0x01 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: ASCII encoding. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_ASCII 0x02 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: UTF-8 encoding. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_UTF8 0x03 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: First bit of the four bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_FIRST_BIT 4 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: Last bit of the four bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_LAST_BIT ((ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_FIRST_BIT) + 8 - 1) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: Bit mask. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: Extracts the protocol identifier bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_GET_CODE_SET(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data code set: Stores into the protocol identifier bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_PUT_CODE_SET(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_CODE_SET_LAST_BIT)) - - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Vendor specific. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_VENDOR_SPEC 0x00 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: T10 vendor identifier. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_T10_VENDOR_ID 0x01 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: EUI64. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_EUI64 0x02 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: NAA. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_NAA 0x03 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Relative target port. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_REL_TARGET_PORT 0x04 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Target port group. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_TARGET_PORT_GROUP 0x05 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Logical unit group. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_LOGICAL_UNIT_GROUP 0x06 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: MD5 logical unit. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_MD5_LOGICAL_UNIT 0x07 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: SCSI name. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_SCSI_NAME 0x08 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: First bit of the four bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_FIRST_BIT 0 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Last bit of the four bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_LAST_BIT ((ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_FIRST_BIT) + 4 - 1) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Bit mask. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Extracts the type bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_GET_TYPE(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags type: Stores into the type bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_TYPE(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_TYPE_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: Logical unit. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LOGICAL_UNIT 0x0 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: Target port. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_TARGET_PORT 0x1 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: Target device. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_TARGET_DEVICE 0x2 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: First bit of the two bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_FIRST_BIT 4 - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: Last bit of the two bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LAST_BIT ((ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_FIRST_BIT) + 6 - 1) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: Bit mask. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: Extracts the association bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_GET_ASSOC(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags association: Stores into the association bits. -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_PUT_ASSOC(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_FIRST_BIT, ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_ASSOC_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data flags: Protocol Identifier Valid (PIV). -#define ISCSI_SCSI_VPD_SCSI_TARGET_PORT_DESIGN_DESC_INQUIRY_DATA_FLAGS_PIV (1 << 7) - - -/** - * @brief iSCSI SCSI Vital Product Data (VPD) SCSI Target Port Designation Descriptor Inquiry data packet. - * - * This structure is used by the SCSI INQUIRY command - * in order to fill in the result if the EVPD bit is - * set. - */ -typedef struct __attribute__((packed)) iscsi_scsi_vpd_scsi_target_port_design_dec_inquiry_data_packet { - /// Protocol identifier and code set. - uint8_t protocol_id_code_set; - - /// Flags. - int8_t flags; - - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; - - /// Length in bytes. - uint8_t len; - - /// Designator. - uint8_t design[0]; -} iscsi_scsi_vpd_scsi_target_port_design_dec_inquiry_data_packet; - - -/** - * @brief iSCSI SCSI Vital Product Data (VPD) SCSI Port Designation Descriptor Inquiry data packet. - * - * This structure is used by the SCSI INQUIRY command - * in order to fill in the result if the EVPD bit is - * set. - */ -typedef struct __attribute__((packed)) iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet { - /// Reserved for future usage (always MUST be 0). - uint16_t reserved; - - /// Relative port identifier. - uint16_t rel_port_id; - - /// Reserved for future usage (always MUST be 0). - uint16_t reserved2; - - /// Initiator port length in bytes. - uint16_t init_port_len; - - /// Initiator port identifier. - uint16_t init_port_id[0]; - - /// Reserved for future usage (always MUST be 0). - uint16_t reserved3; - - /// SCSI Target Port Designation Descriptor length in bytes. - uint16_t target_desc_len; - - /// SCSI Target Port Designation Descriptor. - iscsi_scsi_vpd_scsi_target_port_design_dec_inquiry_data_packet target_desc[0]; -} iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet; - - -/** - * @brief iSCSI SCSI command INQUIRY Vital Product Data (VPD) SCSI Port Designation Descriptor entry fill. - * - * This structure is used by iterating through - * all iSCSI device ports in order to fill in - * the INQUIRY Vital Product Data (VPD) SCSI - * Port Designation Descriptor structure. - */ -typedef struct iscsi_scsi_emu_primary_inquiry_ports_fill { - /// Pointer to current Vital Product Data (VPD) SCSI Port Designation Descriptor entry packet data. - iscsi_scsi_vpd_scsi_port_design_dec_inquiry_data_packet *port_entry; - - /// Total length of Vital Product Data (VPD) SCSI Port Designation Descriptor entry packet data in bytes. - uint alloc_len; - - /// Total remaining allocation length for packet data in bytes. - uint len; -} iscsi_scsi_emu_primary_inquiry_ports_fill; - - /// iSCSI SCSI Vital Product Data (VPD) Page Block Limits Inquiry data UNMAP Granularity Alignment: First bit of the thirty one bits. #define ISCSI_SCSI_VPD_PAGE_BLOCK_LIMITS_INQUIRY_DATA_UNMAP_GRANULARITY_ALIGN_FIRST_BIT 0L @@ -3392,44 +1896,44 @@ typedef struct iscsi_scsi_emu_primary_inquiry_ports_fill { * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_block_limits_inquiry_data_packet { - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Maximum COMPARE AND WRITE length in logical blocks. - uint8_t max_cmp_write_len; + /// Maximum COMPARE AND WRITE length in logical blocks. + uint8_t max_cmp_write_len; - /// Optimal transfer length granularity in logical blocks. - uint16_t optimal_granularity_xfer_len; + /// Optimal transfer length granularity in logical blocks. + uint16_t optimal_granularity_xfer_len; - /// Maximum transfer length in logical blocks. - uint32_t max_xfer_len; + /// Maximum transfer length in logical blocks. + uint32_t max_xfer_len; - /// Optimal transfer length in logical blocks. - uint32_t optimal_xfer_len; + /// Optimal transfer length in logical blocks. + uint32_t optimal_xfer_len; - /// Maximum prefetch length in logical blocks. - uint32_t max_prefetch_len; + /// Maximum prefetch length in logical blocks. + uint32_t max_prefetch_len; - /// Maximum UNMAP LBA count in LBAs. - uint32_t max_unmap_lba_cnt; + /// Maximum UNMAP LBA count in LBAs. + uint32_t max_unmap_lba_cnt; - /// Maximum UNMAP block descriptor count in block descriptors. - uint32_t max_unmap_block_desc_cnt; + /// Maximum UNMAP block descriptor count in block descriptors. + uint32_t max_unmap_block_desc_cnt; - /// Optimal UNMAP granularity in logical blocks. - uint32_t optimal_unmap_granularity; + /// Optimal UNMAP granularity in logical blocks. + uint32_t optimal_unmap_granularity; - /// UNMAP granularity alignment (first LBA) and UGAVALID bit. - uint32_t unmap_granularity_align_ugavalid; + /// UNMAP granularity alignment (first LBA) and UGAVALID bit. + uint32_t unmap_granularity_align_ugavalid; - /// Maximum WRITE SAME length in logical blocks. - uint64_t max_write_same_len; + /// Maximum WRITE SAME length in logical blocks. + uint64_t max_write_same_len; - /// Reserved for future usage (always MUST be 0). - uint64_t reserved[2]; + /// Reserved for future usage (always MUST be 0). + uint64_t reserved[2]; - /// Reserved for future usage (always MUST be 0). - uint32_t reserved2; + /// Reserved for future usage (always MUST be 0). + uint32_t reserved2; } iscsi_scsi_vpd_page_block_limits_inquiry_data_packet; /// iSCSI SCSI Vital Product Data (VPD) Page Block Device Characteristics Inquiry data medium rotation rate: Medium rotation rate is not reported. @@ -3525,131 +2029,32 @@ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_block_limits_inquiry_ * set. */ typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_block_dev_chars_inquiry_data_packet { - /// Medium rotation rate. - uint16_t medium_rotation_rate; + /// Medium rotation rate. + uint16_t medium_rotation_rate; - /// Product type. - uint8_t product_type; + /// Product type. + uint8_t product_type; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Support flags. - uint8_t support_flags; + /// Support flags. + uint8_t support_flags; - /// Reserved for future usage (always MUST be 0). - uint64_t reserved[6]; + /// Reserved for future usage (always MUST be 0). + uint64_t reserved[6]; - /// Reserved for future usage (always MUST be 0). - uint32_t reserved2; + /// Reserved for future usage (always MUST be 0). + uint32_t reserved2; - /// Reserved for future usage (always MUST be 0). - uint16_t reserved3; + /// Reserved for future usage (always MUST be 0). + uint16_t reserved3; - /// Reserved for future usage (always MUST be 0). - uint8_t reserved4; + /// Reserved for future usage (always MUST be 0). + uint8_t reserved4; } iscsi_scsi_vpd_page_block_dev_chars_inquiry_data_packet; -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data flags: Descriptor Present (DP). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_FLAGS_DP (1 << 0) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data flags: Anchor Supported (ANC_SUP). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_FLAGS_ANC_SUP (1 << 1) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data flags: Logical Block Provisioning Read Zeros (LBPRZ). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_FLAGS_LBPRZ (1 << 2) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data flags: Logical Block Provisioning WRITE SAME(10) (LBPWS10). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_FLAGS_LBPWS10 (1 << 5) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data flags: Logical Block Provisioning WRITE SAME (LBPWS). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_FLAGS_LBPWS (1 << 6) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data flags: Logical Block Provisioning UNMAP (LBPU). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_FLAGS_LBPU (1 << 7) - - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: The device server does NOT report a provisioning type. -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_PROVISIONING_NOT_REPORTED 0x0 - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: The logical unit is resource provisioned (see SBC3). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_RESOURCE_PROVISIONING 0x1 - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: The logical unit is thin provisioned (see SBC3). -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_THIN_PROVISIONING 0x2 - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: First bit of the three bits. -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_FIRST_BIT 0 - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: Last bit of the three bits. -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_LAST_BIT ((ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_FIRST_BIT) + 3 - 1) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: Bit mask. -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_MASK (ISCSI_BITS_GET_MASK(ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_FIRST_BIT, ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: Extracts the provision type bits. -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_GET_PROVISION_TYPE(x) (ISCSI_BITS_GET((x), ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_FIRST_BIT, ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_LAST_BIT)) - -/// iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data provision type: Stores into the provision type bits. -#define ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PUT_PROVISION_TYPE(x) (ISCSI_BITS_PUT((x), ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_FIRST_BIT, ISCSI_SCSI_VPD_PAGE_THIN_PROVISION_INQUIRY_DATA_PROVISION_TYPE_LAST_BIT)) - - -/** - * @brief iSCSI SCSI Vital Product Data (VPD) Page Thin Provision Inquiry data packet. - * - * This structure is used by the SCSI INQUIRY command - * in order to fill in the result if the EVPD bit is - * set. - */ -typedef struct __attribute__((packed)) iscsi_scsi_vpd_page_thin_provision_inquiry_data_packet { - /// Threshold exponent. - uint8_t threshold_exponent; - - /// Flags. - int8_t flags; - - /// Provision type. - uint8_t provision_type; - - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; - - /// Provision group descriptors. - uint8_t provision_group_desc[0]; -} iscsi_scsi_vpd_page_thin_provision_inquiry_data_packet; - - -/** - * @brief iSCSI SCSI Sense Event data packet. - * - * For a SCSI event, this data accompanies the report in the data - * segment and identifies the condition. - * - * For an iSCSI event, additional vendor-unique data MAY accompany the - * Async event. Initiators MAY ignore the data when not understood, - * while processing the rest of the PDU. - * - * If the DataSegmentLength is not 0, the format of the DataSegment is - * as follows: - */ -typedef struct __attribute__((packed)) iscsi_scsi_sense_event_data_packet { - /** - * @brief SenseLength. - * - * This is the length of Sense Data. When the Sense Data field is empty - * (e.g., the event is not a SCSI event), SenseLength is 0. - */ - uint16_t sense_len; - - /// Sense Data. - uint16_t sense_data[0]; - - /// iSCSI Event Data. - uint16_t event_data[0]; -} iscsi_scsi_sense_event_data_packet; - - /// iSCSI SCSI sense data response code: Current format. #define ISCSI_SCSI_SENSE_DATA_RESPONSE_CODE_CURRENT_FMT 0x70 @@ -3707,20 +2112,20 @@ typedef struct __attribute__((packed)) iscsi_scsi_sense_event_data_packet { * all SCSI sense data. */ typedef struct __attribute__((packed)) iscsi_scsi_sense_data_packet { - /// Response code. - int8_t response_code; + /// Response code. + int8_t response_code; - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0). + uint8_t reserved; - /// Sense key and flags. - int8_t sense_key_flags; + /// Sense key and flags. + int8_t sense_key_flags; - /// Information. - uint32_t info; + /// Information. + uint32_t info; - /// Additional sense length in bytes. - uint8_t add_len; + /// Additional sense length in bytes. + uint8_t add_len; } iscsi_scsi_sense_data_packet; /// iSCSI SCSI maximum sense data length. @@ -3753,26 +2158,26 @@ typedef struct __attribute__((packed)) iscsi_scsi_sense_data_packet { * the check condition status code. */ typedef struct __attribute__((packed)) iscsi_scsi_sense_data_check_cond_packet { - /// Basic SCSI sense data packet. - iscsi_scsi_sense_data_packet sense_data; + /// Basic SCSI sense data packet. + iscsi_scsi_sense_data_packet sense_data; - /// Information. - uint32_t cmd_spec_info; + /// Information. + uint32_t cmd_spec_info; - /// Additional Sense Code (ASC). - uint8_t asc; + /// Additional Sense Code (ASC). + uint8_t asc; - /// Additional Sense Code Qualifier (ASCQ). - uint8_t ascq; + /// Additional Sense Code Qualifier (ASCQ). + uint8_t ascq; - /// Field replaceable unit code. - uint8_t field_rep_unit_code; + /// Field replaceable unit code. + uint32_t field_rep_unit_code; - /// Sense key specific. - uint8_t sense_key_spec_flags; + /// Sense key specific. + uint8_t sense_key_spec_flags; - /// Sense key specific. - uint16_t sense_key_spec; + /// Sense key specific. + uint16_t sense_key_spec; } iscsi_scsi_sense_data_check_cond_packet; @@ -3783,11 +2188,11 @@ typedef struct __attribute__((packed)) iscsi_scsi_sense_data_check_cond_packet { * and block length in bytes. */ typedef struct __attribute__((packed)) iscsi_scsi_read_capacity_10_parameter_data_packet { - /// Last valid Logical Block Address (LBA). - uint32_t lba; + /// Last valid Logical Block Address (LBA). + uint32_t lba; - /// Block length in bytes. - uint32_t block_len; + /// Block length in bytes. + uint32_t block_len; } iscsi_scsi_read_capacity_10_parameter_data_packet; @@ -3885,23 +2290,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_read_capacity_10_parameter_dat * block length in bytes and LBP information. */ typedef struct __attribute__((packed)) iscsi_scsi_service_action_in_16_parameter_data_packet { - /// Last valid Logical Block Address (LBA). - uint64_t lba; + /// Last valid Logical Block Address (LBA). + uint64_t lba; - /// Block length in bytes. - uint32_t block_len; + /// Block length in bytes. + uint32_t block_len; - /// Flags: RC_BASIS, P_TYPE and PROT_EN. - int8_t flags; + /// Flags: RC_BASIS, P_TYPE and PROT_EN. + int8_t flags; - /// P_I_EXPONENT and logical blocks per physical block exponent. - uint8_t exponents; + /// P_I_EXPONENT and logical blocks per physical block exponent. + uint8_t exponents; - /// Logical Block Provisioning Management Enabled (LBPME), Logical Block Provisioning Read Zeros (LBPRZ) and Lowest Aligned Logical Block Address (LALBA). - uint16_t lbp_lalba; + /// Logical Block Provisioning Management Enabled (LBPME), Logical Block Provisioning Read Zeros (LBPRZ) and Lowest Aligned Logical Block Address (LALBA). + uint16_t lbp_lalba; - /// Reserved for future usage (always MUST be 0 for now). - uint64_t reserved[2]; + /// Reserved for future usage (always MUST be 0 for now). + uint64_t reserved[2]; } iscsi_scsi_service_action_in_16_parameter_data_packet; @@ -3912,11 +2317,11 @@ typedef struct __attribute__((packed)) iscsi_scsi_service_action_in_16_parameter * LUN list in bytes. */ typedef struct __attribute__((packed)) iscsi_scsi_report_luns_parameter_data_lun_list_packet { - /// Number of LUN's following this packet in bytes. - uint32_t lun_list_len; + /// Number of LUN's following this packet in bytes. + uint32_t lun_list_len; - /// Reserved for future usage (always MUST be 0 for now). - uint32_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint32_t reserved; } iscsi_scsi_report_luns_parameter_data_lun_list_packet; @@ -3927,44 +2332,19 @@ typedef struct __attribute__((packed)) iscsi_scsi_report_luns_parameter_data_lun * LUN list. */ typedef struct __attribute__((packed)) iscsi_scsi_report_luns_parameter_data_lun_entry_packet { - /// Logical Unit Number (LUN). - uint64_t lun; + /// Logical Unit Number (LUN). + uint64_t lun; } iscsi_scsi_report_luns_parameter_data_lun_entry_packet; /** - * @brief iSCSI SCSI command REPORT LUNS parameter data LUN entry fill. - * - * This structure is used by iterating through - * all iSCSI LUNs in order to fill in the - * REPORT LUNS parameter data structure. - */ -typedef struct iscsi_scsi_emu_primary_report_luns_fill { - /// Pointer to LUN list packet data. - iscsi_scsi_report_luns_parameter_data_lun_list_packet *lun_list; - - /// Pointer to current LUN entry packet data. - iscsi_scsi_report_luns_parameter_data_lun_entry_packet *lun_entry; - - /// Total length of LUN entry packet data in bytes. - uint32_t len; - - /// Total remaining allocation length for packet data in bytes. - uint alloc_len; - - /// Select report. - uint select_report; -} iscsi_scsi_emu_primary_report_luns_fill; - - -/** * @brief iSCSI SCSI command MODE SELECT(6) parameter list packet data. * * This returns 32-bit vendor specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_select_6_parameter_list_packet { - /// Vendor specific data. - uint32_t vendor_data; + /// Vendor specific data. + uint32_t vendor_data; } iscsi_scsi_mode_select_6_parameter_list_packet; @@ -3974,8 +2354,8 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_select_6_parameter_list_p * This returns 64-bit vendor specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_select_10_parameter_list_packet { - /// Vendor specific data. - uint64_t vendor_data; + /// Vendor specific data. + uint64_t vendor_data; } iscsi_scsi_mode_select_10_parameter_list_packet; @@ -3993,17 +2373,17 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_select_10_parameter_list_ * data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_6_parameter_header_data_packet { - /// Mode data length in bytes. - uint8_t mode_data_len; + /// Mode data length in bytes. + uint8_t mode_data_len; - /// Medium type. - uint8_t medium_type; + /// Medium type. + uint8_t medium_type; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Block descriptor length in bytes. - uint8_t block_desc_len; + /// Block descriptor length in bytes. + uint8_t block_desc_len; } iscsi_scsi_mode_sense_6_parameter_header_data_packet; @@ -4025,23 +2405,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_6_parameter_header_ * data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_10_parameter_header_data_packet { - /// Mode data length in bytes. - uint16_t mode_data_len; + /// Mode data length in bytes. + uint16_t mode_data_len; - /// Medium type. - uint8_t medium_type; + /// Medium type. + uint8_t medium_type; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Long Logical Block Address (LONGLBA). - uint8_t long_lba; + /// Long Logical Block Address (LONGLBA). + uint8_t long_lba; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Block descriptor length in bytes. - uint16_t block_desc_len; + /// Block descriptor length in bytes. + uint16_t block_desc_len; } iscsi_scsi_mode_sense_10_parameter_header_data_packet; @@ -4053,14 +2433,14 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_10_parameter_header * descriptor data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_lba_parameter_block_desc_data_packet { - /// Number of blocks in logical blocks. - uint32_t num_blocks; + /// Number of blocks in logical blocks. + uint32_t num_blocks; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Logical blcok length in bytes. - uint8_t block_len[3]; + /// Logical blcok length in bytes. + uint8_t block_len[3]; } iscsi_scsi_mode_sense_lba_parameter_block_desc_data_packet; @@ -4072,14 +2452,14 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_lba_parameter_block * descriptor data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_long_lba_parameter_block_desc_data_packet { - /// Number of blocks in logical blocks. - uint64_t num_blocks; + /// Number of blocks in logical blocks. + uint64_t num_blocks; - /// Reserved for future usage (always MUST be 0 for now). - uint32_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint32_t reserved; - /// Logical blcok length in bytes. - uint32_t block_len; + /// Logical blcok length in bytes. + uint32_t block_len; } iscsi_scsi_mode_sense_long_lba_parameter_block_desc_data_packet; @@ -4318,14 +2698,14 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_long_lba_parameter_ * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_mode_page_data_packet { - /// Page code and flags. - int8_t page_code_flags; + /// Page code and flags. + int8_t page_code_flags; - /// Page length in bytes. - uint8_t page_len; + /// Page length in bytes. + uint8_t page_len; - /// Mode parameters. - uint8_t params[0]; + /// Mode parameters. + uint8_t params[0]; } iscsi_scsi_mode_sense_mode_page_data_packet; @@ -4335,17 +2715,17 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_mode_page_data_pack * This returns mode sub page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_mode_sub_page_data_packet { - /// Page code and flags. - int8_t page_code_flags; + /// Page code and flags. + int8_t page_code_flags; - /// Sub page code. - uint8_t sub_page_code; + /// Sub page code. + uint8_t sub_page_code; - /// Page length in bytes. - uint16_t page_len; + /// Page length in bytes. + uint16_t page_len; - /// Mode parameters. - uint8_t params[0]; + /// Mode parameters. + uint8_t params[0]; } iscsi_scsi_mode_sense_mode_sub_page_data_packet; @@ -4355,29 +2735,29 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_mode_sub_page_data_ * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_read_write_err_recovery_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Read retry count. - uint8_t read_retry_cnt; + /// Read retry count. + uint8_t read_retry_cnt; - /// Obselete. - uint8_t obselete[3]; + /// Obselete. + uint8_t obselete[3]; - /// Restricted for MMC-6. - uint8_t restrict_mmc_6; + /// Restricted for MMC-6. + uint8_t restrict_mmc_6; - /// Write_retry count. - uint8_t write_retry_cnt; + /// Write_retry count. + uint8_t write_retry_cnt; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Recovery time limit. - uint16_t recovery_time_limit; + /// Recovery time limit. + uint16_t recovery_time_limit; } iscsi_scsi_mode_sense_read_write_err_recovery_mode_page_data_packet; @@ -4387,32 +2767,32 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_read_write_err_reco * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_disconnect_reconnect_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint16_t reserved; - /// Bus inactivity time limit. - uint16_t bus_inactivity_time_limit; + /// Bus inactivity time limit. + uint16_t bus_inactivity_time_limit; - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved2; + /// Reserved for future usage (always MUST be 0 for now). + uint16_t reserved2; - /// Maximum connect time limit. - uint16_t max_connect_time_limit; + /// Maximum connect time limit. + uint16_t max_connect_time_limit; - /// Maximum burst size. - uint16_t max_burst_size; + /// Maximum burst size. + uint16_t max_burst_size; - /// Restricted. - uint8_t restricted; + /// Restricted. + uint8_t restricted; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved3; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved3; - /// First burst size. - uint16_t first_burst_size; + /// First burst size. + uint16_t first_burst_size; } iscsi_scsi_mode_sense_disconnect_reconnect_mode_page_data_packet; @@ -4422,35 +2802,35 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_disconnect_reconnec * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_verify_err_recovery_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Verify retry count. - uint8_t verify_retry_cnt; + /// Verify retry count. + uint8_t verify_retry_cnt; - /// Obselete. - uint8_t obselete; + /// Obselete. + uint8_t obselete; - /// Head offset count. - uint8_t head_offset_cnt; + /// Head offset count. + uint8_t head_offset_cnt; - /// Data strobe offset count. - uint8_t data_strobe_offset_cnt; + /// Data strobe offset count. + uint8_t data_strobe_offset_cnt; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Write retry count. - uint8_t write_retry_cnt; + /// Write retry count. + uint8_t write_retry_cnt; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved2; - /// Verify_recovery time limit. - uint16_t verify_recovery_time_limit; + /// Verify_recovery time limit. + uint16_t verify_recovery_time_limit; } iscsi_scsi_mode_sense_verify_err_recovery_mode_page_data_packet; @@ -4485,41 +2865,41 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_verify_err_recovery * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_caching_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Retention priority. - uint8_t retention_pri; + /// Retention priority. + uint8_t retention_pri; - /// Disable prefetch transfer length. - uint16_t disable_prefetch_xfer_len; + /// Disable prefetch transfer length. + uint16_t disable_prefetch_xfer_len; - /// Minimum prefetch. - uint16_t min_prefetch; + /// Minimum prefetch. + uint16_t min_prefetch; - /// Maximum prefetch. - uint16_t max_prefetch; + /// Maximum prefetch. + uint16_t max_prefetch; - /// Maximum prefetch ceiling. - uint16_t max_prefetch_ceil; + /// Maximum prefetch ceiling. + uint16_t max_prefetch_ceil; - /// Cache flags. - int8_t cache_flags; + /// Cache flags. + int8_t cache_flags; - /// Number of cache segments. - uint8_t num_cache_segs; + /// Number of cache segments. + uint8_t num_cache_segs; - /// Cache segment size. - uint16_t cache_seg_size; + /// Cache segment size. + uint16_t cache_seg_size; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Obselete. - uint8_t obselete[3]; + /// Obselete. + uint8_t obselete[3]; } iscsi_scsi_mode_sense_caching_mode_page_data_packet; @@ -4529,29 +2909,29 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_caching_mode_page_d * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_control_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Queue flags. - int8_t queue_flags; + /// Queue flags. + int8_t queue_flags; - /// Control flags. - int8_t control_flags; + /// Control flags. + int8_t control_flags; - /// Application task flags. - int8_t app_task_flags; + /// Application task flags. + int8_t app_task_flags; - /// Ready AER holdoff period. - uint16_t ready_aer_holdoff_period; + /// Ready AER holdoff period. + uint16_t ready_aer_holdoff_period; - /// Busy timeout period. - uint16_t busy_timeout_period; + /// Busy timeout period. + uint16_t busy_timeout_period; - /// Extended self-test completition time. - uint16_t ext_self_test_complete_time; + /// Extended self-test completition time. + uint16_t ext_self_test_complete_time; } iscsi_scsi_mode_sense_control_mode_page_data_packet; @@ -4561,23 +2941,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_control_mode_page_d * This returns mode sub page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_control_ext_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_sub_page_data_packet mode_sub_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_sub_page_data_packet mode_sub_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Initial command priority. - uint8_t init_cmd_pri; + /// Initial command priority. + uint8_t init_cmd_pri; - /// Maximum sense data length in bytes. - uint8_t max_sense_data_len; + /// Maximum sense data length in bytes. + uint8_t max_sense_data_len; - /// Reserved for future usage (always MUST be 0 for now). - uint64_t reserved[3]; + /// Reserved for future usage (always MUST be 0 for now). + uint64_t reserved[3]; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved2; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved2; } iscsi_scsi_mode_sense_control_ext_mode_page_data_packet; @@ -4587,32 +2967,32 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_control_ext_mode_pa * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_xor_ext_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved; - /// Maximum XOR write size in logical blocks. - uint32_t max_xor_write_size; + /// Maximum XOR write size in logical blocks. + uint32_t max_xor_write_size; - /// Reserved for future usage (always MUST be 0 for now). - uint32_t reserved2; + /// Reserved for future usage (always MUST be 0 for now). + uint32_t reserved2; - /// Maximum regenerate size in logical blocks. - uint32_t max_regenerate_size; + /// Maximum regenerate size in logical blocks. + uint32_t max_regenerate_size; - /// Reserved for future usage (always MUST be 0 for now). - uint32_t reserved3; + /// Reserved for future usage (always MUST be 0 for now). + uint32_t reserved3; - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved4; + /// Reserved for future usage (always MUST be 0 for now). + uint16_t reserved4; - /// Rebuild delay. - uint16_t rebuild_delay; + /// Rebuild delay. + uint16_t rebuild_delay; } iscsi_scsi_mode_sense_xor_ext_mode_page_data_packet; @@ -4622,44 +3002,44 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_xor_ext_mode_page_d * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_power_cond_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Idle and standby flags. - int8_t idle_standby_flags; + /// Idle and standby flags. + int8_t idle_standby_flags; - /// idle_a condition timer. - uint32_t idle_a_cond_timer; + /// idle_a condition timer. + uint32_t idle_a_cond_timer; - /// standby_z condition timer. - uint32_t standby_z_cond_timer; + /// standby_z condition timer. + uint32_t standby_z_cond_timer; - /// idle_b condition timer. - uint32_t idle_b_cond_timer; + /// idle_b condition timer. + uint32_t idle_b_cond_timer; - /// idle_c condition timer. - uint32_t idle_c_cond_timer; + /// idle_c condition timer. + uint32_t idle_c_cond_timer; - /// standby_y condition timer. - uint32_t standby_y_cond_timer; + /// standby_y condition timer. + uint32_t standby_y_cond_timer; - /// Reserved for future usage (always MUST be 0 for now). - uint64_t reserved; + /// Reserved for future usage (always MUST be 0 for now). + uint64_t reserved; - /// Reserved for future usage (always MUST be 0 for now). - uint32_t reserved2; + /// Reserved for future usage (always MUST be 0 for now). + uint32_t reserved2; - /// Reserved for future usage (always MUST be 0 for now). - uint16_t reserved3; + /// Reserved for future usage (always MUST be 0 for now). + uint16_t reserved3; - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved4; + /// Reserved for future usage (always MUST be 0 for now). + uint8_t reserved4; - /// Check Condition From (CCF) flags. - int8_t ccf_flags; + /// Check Condition From (CCF) flags. + int8_t ccf_flags; } iscsi_scsi_mode_sense_power_cond_mode_page_data_packet; @@ -4669,65 +3049,23 @@ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_power_cond_mode_pag * This returns mode page specific data. */ typedef struct __attribute__((packed)) iscsi_scsi_mode_sense_info_exceptions_control_mode_page_data_packet { - /// Mode page. - iscsi_scsi_mode_sense_mode_page_data_packet mode_page; + /// Mode page. + iscsi_scsi_mode_sense_mode_page_data_packet mode_page; - /// Flags. - int8_t flags; + /// Flags. + int8_t flags; - /// Method Of Reporting Informational Exceptions (MRIE) flags. - uint8_t mrie; + /// Method Of Reporting Informational Exceptions (MRIE) flags. + uint8_t mrie; - /// Interval timer. - uint32_t interval_timer; + /// Interval timer. + uint32_t interval_timer; - /// Report count. - uint32_t report_cnt; + /// Report count. + uint32_t report_cnt; } iscsi_scsi_mode_sense_info_exceptions_control_mode_page_data_packet; -/** - * @brief iSCSI SCSI command PERSISTENT RESERVE OUT parameter list packet data. - * - * This returns persistent storage specific data - * like the reservation and service action keys. - */ -typedef struct __attribute__((packed)) iscsi_scsi_pr_reserve_out_parameter_list_packet { - /// Reservation key. - uint64_t r_key; - - /// Service action reservation key. - uint64_t sa_key; - - /// Obselete. - uint32_t obselete; - - /// Flags. - int8_t flags; - - /// Reserved for future usage (always MUST be 0 for now). - uint8_t reserved; - - /// Obselete. - uint16_t obselete2; - -} iscsi_scsi_pr_reserve_out_parameter_list_packet; - - -/** - * @brief iSCSI SCSI command PERSISTENT RESERVE IN parameter data packet data. - * - * This returns persistent storage specific data - * like the reservation and service action keys. - */ -typedef struct __attribute__((packed)) iscsi_scsi_pr_reserve_in_parameter_data_packet { - /// Persistent Reservations (PR) Generation. - uint32_t pr_gen; - - /// Additional length in bytes. - uint32_t add_len; -} iscsi_scsi_pr_reserve_in_parameter_data_packet; - /// SCSI command opcode (embedded in iSCSI protocol): TEST UNIT READY. #define ISCSI_SCSI_OPCODE_TESTUNITREADY 0x00 @@ -4954,86 +3292,80 @@ typedef struct __attribute__((packed)) iscsi_scsi_pr_reserve_in_parameter_data_p * direction is indicated by the R and/or W bit). */ typedef struct __attribute__((packed)) iscsi_scsi_cmd_packet { - /// Always 1 according to the iSCSI specification. - uint8_t opcode; - - /// Flags and Task Attributes. - int8_t flags_task; - - /// Reserved for future usage, MUST always be 0. - uint16_t reserved; - - /// Total length of AHS. - uint8_t total_ahs_len; - - /// Length of DataSegment. - uint8_t ds_len[3]; - - /// SCSI LUN bit mask. - uint64_t lun; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /** - * @brief Expected Data Transfer Length. - * - * For unidirectional operations, the Expected Data Transfer Length - * field contains the number of bytes of data involved in this SCSI - * operation. For a unidirectional write operation (W flag set to 1 and - * R flag set to 0), the initiator uses this field to specify the number - * of bytes of data it expects to transfer for this operation. For a - * unidirectional read operation (W flag set to 0 and R flag set to 1), - * the initiator uses this field to specify the number of bytes of data - * it expects the target to transfer to the initiator. It corresponds - * to the SAM-2 byte count.\n - * For bidirectional operations (both R and W flags are set to 1), this - * field contains the number of data bytes involved in the write - * transfer. For bidirectional operations, an additional header segment - * MUST be present in the header sequence that indicates the - * Bidirectional Read Expected Data Transfer Length. The Expected Data - * Transfer Length field and the Bidirectional Read Expected Data - * Transfer Length field correspond to the SAM-2 byte count. - * If the Expected Data Transfer Length for a write and the length of - * the immediate data part that follows the command (if any) are the - * same, then no more data PDUs are expected to follow. In this case, - * the F bit MUST be set to 1.\n - * If the Expected Data Transfer Length is higher than the - * FirstBurstLength (the negotiated maximum amount of unsolicited data - * the target will accept), the initiator MUST send the maximum amount - * of unsolicited data OR ONLY the immediate data, if any. - * Upon completion of a data transfer, the target informs the initiator - * (through residual counts) of how many bytes were actually processed - * (sent and/or received) by the target. - */ - uint32_t exp_xfer_len; - - /// The CmdSN enables ordered delivery across multiple connections in a single session. - uint32_t cmd_sn; - - /// Command responses up to ExpStatSN - 1 (modulo 2**32) have been received (acknowledges status) on the connection. - uint32_t exp_stat_sn; - - /** - * @brief SCSI Command Descriptor Block (CDB). - * - * There are 16 bytes in the CDB field to accommodate the commonly used - * CDBs. Whenever the CDB is larger than 16 bytes, an Extended CDB AHS - * MUST be used to contain the CDB spillover. - */ - iscsi_scsi_cdb scsi_cdb; - - /// Optional AHS packet data. - iscsi_ahs_packet ahs; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /// Optional data segment, command data. - iscsi_scsi_ds_cmd_data ds_cmd_data; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 1 according to the iSCSI specification. + uint8_t opcode; + + /// Flags and Task Attributes. + int8_t flags_task; + + /// Reserved for future usage, MUST always be 0. + uint16_t reserved; + + /// Total length of AHS. + uint8_t total_ahs_len; + + /// Length of DataSegment. + uint8_t ds_len[3]; + + /// SCSI LUN bit mask. + uint64_t lun; + + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; + + /** + * @brief Expected Data Transfer Length. + * + * For unidirectional operations, the Expected Data Transfer Length + * field contains the number of bytes of data involved in this SCSI + * operation. For a unidirectional write operation (W flag set to 1 and + * R flag set to 0), the initiator uses this field to specify the number + * of bytes of data it expects to transfer for this operation. For a + * unidirectional read operation (W flag set to 0 and R flag set to 1), + * the initiator uses this field to specify the number of bytes of data + * it expects the target to transfer to the initiator. It corresponds + * to the SAM-2 byte count.\n + * For bidirectional operations (both R and W flags are set to 1), this + * field contains the number of data bytes involved in the write + * transfer. For bidirectional operations, an additional header segment + * MUST be present in the header sequence that indicates the + * Bidirectional Read Expected Data Transfer Length. The Expected Data + * Transfer Length field and the Bidirectional Read Expected Data + * Transfer Length field correspond to the SAM-2 byte count. + * If the Expected Data Transfer Length for a write and the length of + * the immediate data part that follows the command (if any) are the + * same, then no more data PDUs are expected to follow. In this case, + * the F bit MUST be set to 1.\n + * If the Expected Data Transfer Length is higher than the + * FirstBurstLength (the negotiated maximum amount of unsolicited data + * the target will accept), the initiator MUST send the maximum amount + * of unsolicited data OR ONLY the immediate data, if any. + * Upon completion of a data transfer, the target informs the initiator + * (through residual counts) of how many bytes were actually processed + * (sent and/or received) by the target. + */ + uint32_t exp_xfer_len; + + /// The CmdSN enables ordered delivery across multiple connections in a single session. + uint32_t cmd_sn; + + /// Command responses up to ExpStatSN - 1 (modulo 2**32) have been received (acknowledges status) on the connection. + uint32_t exp_stat_sn; + + /** + * @brief SCSI Command Descriptor Block (CDB). + * + * There are 16 bytes in the CDB field to accommodate the commonly used + * CDBs. Whenever the CDB is larger than 16 bytes, an Extended CDB AHS + * MUST be used to contain the CDB spillover. + */ + iscsi_scsi_cdb scsi_cdb; + + /// Optional AHS packet data. + iscsi_ahs_packet ahs; + + /// Optional data segment, command data. + iscsi_scsi_ds_cmd_data ds_cmd_data; } iscsi_scsi_cmd_packet; @@ -5234,497 +3566,133 @@ typedef struct __attribute__((packed)) iscsi_scsi_cmd_packet { * terms, response value 0x00 maps to the SCSI service response (see */ typedef struct __attribute__((packed)) iscsi_scsi_response_packet { - /// Always 0x21 according to specification. - uint8_t opcode; - - /// Flags. - int8_t flags; - - /// This field contains the iSCSI service response. - uint8_t response; - - /// The Status field is used to report the SCSI status of the command (as specified in SAM2) and is only valid if the response code is Command Completed at Target. - uint8_t status; - - /// Total AHS length. - uint8_t total_ahs_len; - - /// Data segment length. - uint8_t ds_len[3]; - - /// Reserved for future usage. Always MUST be 0. - uint64_t reserved; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /** - * @brief Copy of the last accepted Selective Negative / Sequence Number Acknowledgment (SNACK) tag. - * - * This field contains a copy of the SNACK Tag of the last SNACK Tag - * accepted by the target on the same connection and for the command for - * which the response is issued. Otherwise, it is reserved and should - * be set to 0.\n - * After issuing a R-Data SNACK, the initiator must discard any SCSI - * status unless contained in a SCSI Response PDU carrying the same - * SNACK Tag as the last issued R-Data SNACK for the SCSI command on the - * current connection. - */ - uint32_t snack_tag; - - /** - * @brief StatSN - Status Sequence Number. - * - * The StatSN is a sequence number that the target iSCSI layer generates - * per connection and that in turn enables the initiator to acknowledge - * status reception. The StatSN is incremented by 1 for every - * response/status sent on a connection, except for responses sent as a - * result of a retry or SNACK. In the case of responses sent due to a - * retransmission request, the StatSN MUST be the same as the first time - * the PDU was sent, unless the connection has since been restarted. - */ - uint32_t stat_sn; - - /** - * @brief ExpCmdSN - Next Expected CmdSN from This Initiator. - * - * The ExpCmdSN is a sequence number that the target iSCSI returns to - * the initiator to acknowledge command reception. It is used to update - * a local variable with the same name. An ExpCmdSN equal to - * MaxCmdSN + 1 indicates that the target cannot accept new commands. - */ - uint32_t exp_cmd_sn; - - /** - * @brief MaxCmdSN - Maximum CmdSN from This Initiator. - * - * The MaxCmdSN is a sequence number that the target iSCSI returns to - * the initiator to indicate the maximum CmdSN the initiator can send. - * It is used to update a local variable with the same name. If the - * MaxCmdSN is equal to ExpCmdSN - 1, this indicates to the initiator - * that the target cannot receive any additional commands. When the - * MaxCmdSN changes at the target while the target has no pending PDUs - * to convey this information to the initiator, it MUST generate a - * NOP-In to carry the new MaxCmdSN. - */ - uint32_t max_cmd_sn; - - /** - * @brief ExpDataSN or Reserved. - * - * This field indicates the number of Data-In (read) PDUs the target has - * sent for the command.\n - * This field MUST be 0 if the response code is not Command Completed at - * Target or the target sent no Data-In PDUs for the command. - */ - uint32_t exp_data_sn; - - /** - * @brief Bidirectional Read Residual Count or Reserved. - * - * The Bidirectional Read Residual Count field MUST be valid in the case - * where either the u bit or the o bit is set. If neither bit is set, - * the Bidirectional Read Residual Count field is reserved. Targets may - * set the Bidirectional Read Residual Count, and initiators may use it - * when the response code is Command Completed at Target. If the o bit - * is set, the Bidirectional Read Residual Count indicates the number of - * bytes that were not transferred to the initiator because the - * initiator's Bidirectional Read Expected Data Transfer Length was not - * sufficient. If the u bit is set, the Bidirectional Read Residual - * Count indicates the number of bytes that were not transferred to the - * initiator out of the number of bytes expected to be transferred. - */ - uint32_t bidi_read_res_cnt; - - /** - * @brief Residual Count or Reserved. - * - * The Residual Count field MUST be valid in the case where either the U - * bit or the O bit is set. If neither bit is set, the Residual Count - * field MUST be ignored on reception and SHOULD be set to 0 when - * sending. Targets may set the residual count, and initiators may use - * it when the response code is Command Completed at Target (even if the - * status returned is not GOOD). If the O bit is set, the Residual - * Count indicates the number of bytes that were not transferred because - * the initiator's Expected Data Transfer Length was not sufficient. If - * the U bit is set, the Residual Count indicates the number of bytes - * that were not transferred out of the number of bytes expected to be - * transferred. - */ - uint32_t res_cnt; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /// Optional data segment, command data. - iscsi_scsi_ds_cmd_data ds_cmd_data; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 0x21 according to specification. + uint8_t opcode; + + /// Flags. + int8_t flags; + + /// This field contains the iSCSI service response. + uint8_t response; + + /// The Status field is used to report the SCSI status of the command (as specified in SAM2) and is only valid if the response code is Command Completed at Target. + uint8_t status; + + /// Total AHS length. + uint8_t total_ahs_len; + + /// Data segment length. + uint8_t ds_len[3]; + + /// Reserved for future usage. Always MUST be 0. + uint64_t reserved; + + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; + + /** + * @brief Copy of the last accepted Selective Negative / Sequence Number Acknowledgment (SNACK) tag. + * + * This field contains a copy of the SNACK Tag of the last SNACK Tag + * accepted by the target on the same connection and for the command for + * which the response is issued. Otherwise, it is reserved and should + * be set to 0.\n + * After issuing a R-Data SNACK, the initiator must discard any SCSI + * status unless contained in a SCSI Response PDU carrying the same + * SNACK Tag as the last issued R-Data SNACK for the SCSI command on the + * current connection. + */ + uint32_t snack_tag; + + /** + * @brief StatSN - Status Sequence Number. + * + * The StatSN is a sequence number that the target iSCSI layer generates + * per connection and that in turn enables the initiator to acknowledge + * status reception. The StatSN is incremented by 1 for every + * response/status sent on a connection, except for responses sent as a + * result of a retry or SNACK. In the case of responses sent due to a + * retransmission request, the StatSN MUST be the same as the first time + * the PDU was sent, unless the connection has since been restarted. + */ + uint32_t stat_sn; + + /** + * @brief ExpCmdSN - Next Expected CmdSN from This Initiator. + * + * The ExpCmdSN is a sequence number that the target iSCSI returns to + * the initiator to acknowledge command reception. It is used to update + * a local variable with the same name. An ExpCmdSN equal to + * MaxCmdSN + 1 indicates that the target cannot accept new commands. + */ + uint32_t exp_cmd_sn; + + /** + * @brief MaxCmdSN - Maximum CmdSN from This Initiator. + * + * The MaxCmdSN is a sequence number that the target iSCSI returns to + * the initiator to indicate the maximum CmdSN the initiator can send. + * It is used to update a local variable with the same name. If the + * MaxCmdSN is equal to ExpCmdSN - 1, this indicates to the initiator + * that the target cannot receive any additional commands. When the + * MaxCmdSN changes at the target while the target has no pending PDUs + * to convey this information to the initiator, it MUST generate a + * NOP-In to carry the new MaxCmdSN. + */ + uint32_t max_cmd_sn; + + /** + * @brief ExpDataSN or Reserved. + * + * This field indicates the number of Data-In (read) PDUs the target has + * sent for the command.\n + * This field MUST be 0 if the response code is not Command Completed at + * Target or the target sent no Data-In PDUs for the command. + */ + uint32_t exp_data_sn; + + /** + * @brief Bidirectional Read Residual Count or Reserved. + * + * The Bidirectional Read Residual Count field MUST be valid in the case + * where either the u bit or the o bit is set. If neither bit is set, + * the Bidirectional Read Residual Count field is reserved. Targets may + * set the Bidirectional Read Residual Count, and initiators may use it + * when the response code is Command Completed at Target. If the o bit + * is set, the Bidirectional Read Residual Count indicates the number of + * bytes that were not transferred to the initiator because the + * initiator's Bidirectional Read Expected Data Transfer Length was not + * sufficient. If the u bit is set, the Bidirectional Read Residual + * Count indicates the number of bytes that were not transferred to the + * initiator out of the number of bytes expected to be transferred. + */ + uint32_t bidi_read_res_cnt; + + /** + * @brief Residual Count or Reserved. + * + * The Residual Count field MUST be valid in the case where either the U + * bit or the O bit is set. If neither bit is set, the Residual Count + * field MUST be ignored on reception and SHOULD be set to 0 when + * sending. Targets may set the residual count, and initiators may use + * it when the response code is Command Completed at Target (even if the + * status returned is not GOOD). If the O bit is set, the Residual + * Count indicates the number of bytes that were not transferred because + * the initiator's Expected Data Transfer Length was not sufficient. If + * the U bit is set, the Residual Count indicates the number of bytes + * that were not transferred out of the number of bytes expected to be + * transferred. + */ + uint32_t res_cnt; + + /// Optional data segment, command data. + iscsi_scsi_ds_cmd_data ds_cmd_data; } iscsi_scsi_response_packet; - -/// Task management request function: ABORT TASK: aborts the task identified by the Referenced Task Tag field. -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_ABORT_TASK 0x01 - -/// Task management request function: ABORT TASK SET: aborts all tasks issued via this session on the LU. -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_ABORT_TASK_SET 0x02 - -/// Task management request function: CLEAR ACA - clears the Auto Contingent Allegiance condition. -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_CLEAR_ACA 0x03 - -/// Task management request function: CLEAR TASK SET - aborts all tasks in the appropriate task set as defined by the TST field in the Control mode page (see SPC3). -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_CLEAR_TASK_SET 0x04 - -/// Task management request function: LOGICAL UNIT RESET. -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_LOGICAL_UNIT_RESET 0x05 - -/// Task management request function: TARGET WARM RESET. -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_TARGET_WARM_RESET 0x06 - -/// Task management request function: TARGET COLD RESET. -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_TARGET_COLD_RESET 0x07 - -/// Task management request function: TASK REASSIGN - reassigns connection allegiance for the task identified by the Initiator Task Tag field to this connection, thus resuming the iSCSI exchanges for the task. -#define ISCSI_TASK_MGMT_FUNC_REQ_FUNC_TASK_REASSIGN 0x08 - - -/** - * @brief iSCSI Task Management Function Request packet data. - * - * This structure is used to explicity control the execution of one - * or more tasks (iSCSI and SCSI). - */ -typedef struct __attribute__((packed)) iscsi_task_mgmt_func_req_packet { - /// Always 2 according to iSCSI specification. - uint8_t opcode; - - /** - * @brief Function. - * - * The task management functions provide an initiator with a way to - * explicitly control the execution of one or more tasks (SCSI and iSCSI - * tasks). The task management function codes are listed below. For a - * more detailed description of SCSI task management, see SAM2. - */ - int8_t func; - - /// Reserved fot future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength (MUST be 0 for this PDU). - uint8_t total_ahs_len; - - /// DataSegmentLength (MUST be 0 for this PDU). - uint8_t ds_len[3]; - - /** - * @brief Logical Unit Number (LUN) or Reserved. - * - * This field is required for functions that address a specific LU - * (ABORT TASK, CLEAR TASK SET, ABORT TASK SET, CLEAR ACA, LOGICAL UNIT - * RESET) and is reserved in all others - */ - uint64_t lun; - - /** - * @brief Initiator Task Tag (ITT). - * - * This is the Initiator Task Tag of the task to be aborted for the - * ABORT TASK function or reassigned for the TASK REASSIGN function. - * For all the other functions, this field MUST be set to the reserved - * value 0xFFFFFFFF. - */ - uint32_t init_task_tag; - - /// Referenced task tag or 0xFFFFFFFF. - uint32_t ref_task_tag; - - /// CmdSN. - uint32_t cmd_sn; - - /// ExpStatSN - uint32_t exp_stat_sn; - - /** - * @brief RefCmdSN or Reserved. - * - * If an ABORT TASK is issued for a task created by an immediate - * command, then the RefCmdSN MUST be that of the task management - * request itself (i.e., the CmdSN and RefCmdSN are equal).\n - * For an ABORT TASK of a task created by a non-immediate command, the - * RefCmdSN MUST be set to the CmdSN of the task identified by the - * Referenced Task Tag field. Targets must use this field when the task - * identified by the Referenced Task Tag field is not with the target. - * Otherwise, this field is reserved. - */ - uint32_t ref_cmd_sn; - - /** - * @brief ExpDataSN or Reserved. - * - * For recovery purposes, the iSCSI target and initiator maintain a data - * acknowledgment reference number - the first input DataSN number - * unacknowledged by the initiator. When issuing a new command, this - * number is set to 0. If the function is TASK REASSIGN, which - * establishes a new connection allegiance for a previously issued read - * or bidirectional command, the ExpDataSN will contain an updated data - * acknowledgment reference number or the value 0; the latter indicates - * that the data acknowledgment reference number is unchanged. The - * initiator MUST discard any data PDUs from the previous execution that - * it did not acknowledge, and the target MUST transmit all Data-In PDUs - * (if any) starting with the data acknowledgment reference number. The - * number of retransmitted PDUs may or may not be the same as the - * original transmission, depending on if there was a change in - * MaxRecvDataSegmentLength in the reassignment. The target MAY also - * send no more Data-In PDUs if all data has been acknowledged. - * The value of ExpDataSN MUST be 0 or higher than the DataSN of the - * last acknowledged Data-In PDU, but not larger than DataSN + 1 of the - * last Data-IN PDU sent by the target. Any other value MUST be ignored - * by the target. - * For other functions, this field is reserved - */ - uint32_t exp_data_sn; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2; - - /// Optional header digest. - iscsi_header_digest hdr_digest; -} iscsi_task_mgmt_func_req_packet; - - -/// Task management function response: Function complete. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_FUNC_COMPLETE 0x00 - -/// Task management function response: Task does not exist. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_TASK_NO_EXIST 0x01 - -/// Task management function response: LUN does not exist. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_LUN_NO_EXIST 0x02 - -/// Task management function response: Task still allegiant. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_TASK_ALLEGIANT 0x03 - -/// Task management function response: Task allegiance reassignment not supported. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_TASK_UNSUPPORTED_ALLEGIANCE 0x04 - -/// Task management function response: Task management function not supported. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_TASK_UNSUPPORTED_MGMT 0x05 - -/// Task management function response: Function authorization failed. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_FUNC_AUTH_FAILED 0x06 - -/// Task management function response: Function rejected. -#define ISCSI_TASK_MGMT_FUNC_RESPONSE_FUNC_REJECTED 0xFF - - -/** - * @brief iSCSI Task Management Function Response packet data. - * - * For the functions ABORT TASK, ABORT TASK SET, CLEAR ACA, CLEAR TASK - * SET, LOGICAL UNIT RESET, TARGET COLD RESET, TARGET WARM RESET, and - * TASK REASSIGN, the target performs the requested task management - * function and sends a task management response back to the initiator. - * For TASK REASSIGN, the new connection allegiance MUST ONLY become - * effective at the target after the target issues the task management - * response. - */ -typedef struct __attribute__((packed)) iscsi_task_mgmt_func_response_packet { - /// Always 0x22 according to specification. - uint8_t opcode; - - /// Reserved for future usage (always MUST be 0x80 for now). - int8_t flags; - - /** - * @brief Function response. - * - * For the TARGET COLD RESET and TARGET WARM RESET functions, the target - * cancels all pending operations across all LUs known to the issuing - * initiator. For the TARGET COLD RESET function, the target MUST then - * close all of its TCP connections to all initiators (terminates all - * sessions).\n - * The mapping of the response code into a SCSI service response code - * value, if needed, is outside the scope of this document. However, in - * symbolic terms, Response values 0 and 1 map to the SCSI service - * response of FUNCTION COMPLETE. Response value 2 maps to the SCSI - * service response of INCORRECT LOGICAL UNIT NUMBER. All other - * Response values map to the SCSI service response of FUNCTION - * REJECTED. If a Task Management Function Response PDU does not arrive - * before the session is terminated, the SCSI service response is - * SERVICE DELIVERY OR TARGET FAILURE.\n - * The response to ABORT TASK SET and CLEAR TASK SET MUST only be issued - * by the target after all of the commands affected have been received - * by the target, the corresponding task management functions have been - * executed by the SCSI target, and the delivery of all responses - * delivered until the task management function completion has been - * confirmed (acknowledged through the ExpStatSN) by the initiator on - * all connections of this session.\n - * For the ABORT TASK function,\n - * -# if the Referenced Task Tag identifies a valid task leading to a - * successful termination, then targets must return the "Function - * complete" response. - * -# if the Referenced Task Tag does not identify an existing task - * but the CmdSN indicated by the RefCmdSN field in the Task - * Management Function Request is within the valid CmdSN window - * and less than the CmdSN of the Task Management Function Request - * itself, then targets must consider the CmdSN as received and - * return the "Function complete" response. - * -# if the Referenced Task Tag does not identify an existing task - * and the CmdSN indicated by the RefCmdSN field in the Task - * Management Function Request is outside the valid CmdSN window, - * then targets must return the "Task does not exist" response - */ - uint8_t response; - - /// Reserved for future usage, always MUST be 0. - uint8_t reserved; - - /// TotalAHSLength (MUST be 0 for this PDU). - uint8_t total_ahs_len; - - /// DataSegmentLength (MUST be 0 for this PDU). - uint8_t ds_len[3]; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved3; - - /// StatSN. - uint32_t stat_sn; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved4; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved5; - - /// Optional header digest. - iscsi_header_digest hdr_digest; -} iscsi_task_mgmt_func_response_packet; - /// SCSI data out / in flags: Immediately process transfer. #define ISCSI_SCSI_DATA_OUT_DATA_IN_FLAGS_IMMEDIATE (1 << 7) /** - * @brief iSCSI SCSI Data Out request packet data. - * - * THis structure is used by iSCSI for SCSI data output - * requests, i.e. write operations. - */ -typedef struct __attribute__((packed)) iscsi_scsi_data_out_req_packet { - /// Always 2 according to iSCSI specification. - uint8_t opcode; - - /// Flags. - int8_t flags; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /** - * @brief DataSegmentLength. - * - * This is the data payload length of a SCSI Data-In or SCSI Data-Out - * PDU. The sending of 0-length data segments should be avoided, but - * initiators and targets MUST be able to properly receive 0-length data - * segments.\n - * The data segments of Data-In and Data-Out PDUs SHOULD be filled to - * the integer number of 4-byte words (real payload), unless the F bit - * is set to 1. - */ - uint8_t ds_len[3]; - - /** - * @brief Logical Unit Number (LUN) or Reserved. - * - * If the Target Transfer Tag is provided, then the LUN field MUST hold a - * valid value and be consistent with whatever was specified with the command; - * otherwise, the LUN field is reserved. - */ - uint64_t lun; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /** - * @brief Target Transfer Tag or 0xFFFFFFFF. - * - * On outgoing data, the Target Transfer Tag is provided to the target - * if the transfer is honoring an R2T. In this case, the Target - * Transfer Tag field is a replica of the Target Transfer Tag provided - * with the R2T.\n - * The Target Transfer Tag values are not specified by this protocol, - * except that the value 0xFFFFFFFF is reserved and means that the - * Target Transfer Tag is not supplied. - */ - uint32_t target_xfer_tag; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved2; - - /// ExpStatSN. - uint32_t exp_stat_sn; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved3; - - /** - * @brief DataSN. - * - * For output (write) data PDUs, the DataSN is the Data-Out PDU number - * within the current output sequence. Either the current output - * sequence is identified by the Initiator Task Tag (for unsolicited - * data) or it is a data sequence generated for one R2T (for data - * solicited through R2T). - */ - uint32_t data_sn; - - /** - * @brief Buffer Offset. - * - * The Buffer Offset field contains the offset of this PDU payload data - * within the complete data transfer. The sum of the buffer offset and - * length should not exceed the expected transfer length for the - * command.\n - * The order of data PDUs within a sequence is determined by - * DataPDUInOrder. When set to Yes, it means that PDUs have to be in - * increasing buffer offset order and overlays are forbidden.\n - * The ordering between sequences is determined by DataSequenceInOrder. - * When set to Yes, it means that sequences have to be in increasing - * buffer offset order and overlays are forbidden. - */ - uint32_t buf_offset; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved4; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /// Data segment. - iscsi_scsi_ds_cmd_data ds_cmd_data; - - /// Optional data digest. - iscsi_data_digest data_digest; -} iscsi_scsi_data_out_req_packet; - -/** * @brief SCSI Data In reponse flags: Status. * * (S) set to indicate that the Command Status field @@ -5822,437 +3790,115 @@ typedef struct __attribute__((packed)) iscsi_scsi_data_out_req_packet { * responses, i.e. read operations. */ typedef struct __attribute__((packed)) iscsi_scsi_data_in_response_packet { - /// Always 0x25 according to iSCSI specification. - uint8_t opcode; - - /// Incoming data flags. The fields StatSN, Status, and Residual Count only have meaningful content if the S bit is set to 1. - int8_t flags; - - /// Rserved for future usage, always MUST be 0. - uint8_t reserved; - - /** - * @brief Status or Reserved. - * - * Status can accompany the last Data-In PDU if the command did not end - * with an exception (i.e., the status is "good status" - GOOD, - * CONDITION MET, or INTERMEDIATE-CONDITION MET). The presence of - * status (and of a residual count) is signaled via the S flag bit. - * Although targets MAY choose to send even non-exception status in - * separate responses, initiators MUST support non-exception status in - * Data-In PDUs. - */ - uint8_t status; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /** - * @brief DataSegmentLength. - * - * This is the data payload length of a SCSI Data-In or SCSI Data-Out - * PDU. The sending of 0-length data segments should be avoided, but - * initiators and targets MUST be able to properly receive 0-length data - * segments.\n - * The data segments of Data-In and Data-Out PDUs SHOULD be filled to - * the integer number of 4-byte words (real payload), unless the F bit - * is set to 1. - */ - uint8_t ds_len[3]; - - /** - * @brief Logical Unit Number (LUN) or Reserved. - * - * If the Target Transfer Tag is provided, then the LUN field MUST hold a - * valid value and be consistent with whatever was specified with the command; - * otherwise, the LUN field is reserved. - */ - uint64_t lun; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /** - * @brief Target Transfer Tag or 0xFFFFFFFF. - * - * On incoming data, the Target Transfer Tag and LUN MUST be provided by - * the target if the A bit is set to 1; otherwise, they are reserved. - * The Target Transfer Tag and LUN are copied by the initiator into the - * SNACK of type DataACK that it issues as a result of receiving a SCSI - * Data-In PDU with the A bit set to 1.\n - * The Target Transfer Tag values are not specified by this protocol, - * except that the value 0xFFFFFFFF is reserved and means that the - * Target Transfer Tag is not supplied. - */ - uint32_t target_xfer_tag; - - /// StatSN. - uint32_t stat_sn; - - /// ExpCmdSN. - - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /** - * @brief DataSN. - * - * For input (read) or bidirectional Data-In PDUs, the DataSN is the - * input PDU number within the data transfer for the command identified - * by the Initiator Task Tag.\n - * R2T and Data-In PDUs, in the context of bidirectional commands, share - * the numbering sequence. - */ - uint32_t data_sn; - - /** - * @brief Buffer Offset. - * - * The Buffer Offset field contains the offset of this PDU payload data - * within the complete data transfer. The sum of the buffer offset and - * length should not exceed the expected transfer length for the - * command.\n - * The order of data PDUs within a sequence is determined by - * DataPDUInOrder. When set to Yes, it means that PDUs have to be in - * increasing buffer offset order and overlays are forbidden.\n - * The ordering between sequences is determined by DataSequenceInOrder. - * When set to Yes, it means that sequences have to be in increasing - * buffer offset order and overlays are forbidden. - */ - uint32_t buf_offset; - - /// Residual Count or Reserved. - uint32_t res_cnt; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /// Data segment. - iscsi_scsi_ds_cmd_data ds_cmd_data; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 0x25 according to iSCSI specification. + uint8_t opcode; + + /// Incoming data flags. The fields StatSN, Status, and Residual Count only have meaningful content if the S bit is set to 1. + int8_t flags; + + /// Rserved for future usage, always MUST be 0. + uint8_t reserved; + + /** + * @brief Status or Reserved. + * + * Status can accompany the last Data-In PDU if the command did not end + * with an exception (i.e., the status is "good status" - GOOD, + * CONDITION MET, or INTERMEDIATE-CONDITION MET). The presence of + * status (and of a residual count) is signaled via the S flag bit. + * Although targets MAY choose to send even non-exception status in + * separate responses, initiators MUST support non-exception status in + * Data-In PDUs. + */ + uint8_t status; + + /// TotalAHSLength. + uint8_t total_ahs_len; + + /** + * @brief DataSegmentLength. + * + * This is the data payload length of a SCSI Data-In or SCSI Data-Out + * PDU. The sending of 0-length data segments should be avoided, but + * initiators and targets MUST be able to properly receive 0-length data + * segments.\n + * The data segments of Data-In and Data-Out PDUs SHOULD be filled to + * the integer number of 4-byte words (real payload), unless the F bit + * is set to 1. + */ + uint8_t ds_len[3]; + + /** + * @brief Logical Unit Number (LUN) or Reserved. + * + * If the Target Transfer Tag is provided, then the LUN field MUST hold a + * valid value and be consistent with whatever was specified with the command; + * otherwise, the LUN field is reserved. + */ + uint64_t lun; + + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; + + /** + * @brief Target Transfer Tag or 0xFFFFFFFF. + * + * On incoming data, the Target Transfer Tag and LUN MUST be provided by + * the target if the A bit is set to 1; otherwise, they are reserved. + * The Target Transfer Tag and LUN are copied by the initiator into the + * SNACK of type DataACK that it issues as a result of receiving a SCSI + * Data-In PDU with the A bit set to 1.\n + * The Target Transfer Tag values are not specified by this protocol, + * except that the value 0xFFFFFFFF is reserved and means that the + * Target Transfer Tag is not supplied. + */ + uint32_t target_xfer_tag; + + /// StatSN. + uint32_t stat_sn; + + /// ExpCmdSN. + + uint32_t exp_cmd_sn; + + /// MaxCmdSN. + uint32_t max_cmd_sn; + + /** + * @brief DataSN. + * + * For input (read) or bidirectional Data-In PDUs, the DataSN is the + * input PDU number within the data transfer for the command identified + * by the Initiator Task Tag.\n + * R2T and Data-In PDUs, in the context of bidirectional commands, share + * the numbering sequence. + */ + uint32_t data_sn; + + /** + * @brief Buffer Offset. + * + * The Buffer Offset field contains the offset of this PDU payload data + * within the complete data transfer. The sum of the buffer offset and + * length should not exceed the expected transfer length for the + * command.\n + * The order of data PDUs within a sequence is determined by + * DataPDUInOrder. When set to Yes, it means that PDUs have to be in + * increasing buffer offset order and overlays are forbidden.\n + * The ordering between sequences is determined by DataSequenceInOrder. + * When set to Yes, it means that sequences have to be in increasing + * buffer offset order and overlays are forbidden. + */ + uint32_t buf_offset; + + /// Residual Count or Reserved. + uint32_t res_cnt; + + /// Data segment. + iscsi_scsi_ds_cmd_data ds_cmd_data; } iscsi_scsi_data_in_response_packet; /** - * @brief iSCSI Ready To Transfer packet data. - * - * When an initiator has submitted a SCSI command with data that passes - * from the initiator to the target (write), the target may specify - * which blocks of data it is ready to receive. The target may request - * that the data blocks be delivered in whichever order is convenient - * for the target at that particular instant. This information is - * passed from the target to the initiator in the Ready To Transfer - * (R2T) PDU. - * - * In order to allow write operations without an explicit initial R2T, - * the initiator and target MUST have negotiated the key InitialR2T to - * No during login. - * - * An R2T MAY be answered with one or more SCSI Data-Out PDUs with a - * matching Target Transfer Tag. If an R2T is answered with a single - * Data-Out PDU, the buffer offset in the data PDU MUST be the same as - * the one specified by the R2T, and the data length of the data PDU - * MUST be the same as the Desired Data Transfer Length specified in the - * R2T. If the R2T is answered with a sequence of data PDUs, the buffer - * offset and length MUST be within the range of those specified by the - * R2T, and the last PDU MUST have the F bit set to 1. If the last PDU - * (marked with the F bit) is received before the Desired Data Transfer - * Length is transferred, a target MAY choose to reject that PDU with - * the "Protocol Error" reason code. DataPDUInOrder governs the - * Data-Out PDU ordering. If DataPDUInOrder is set to Yes, the buffer - * offsets and lengths for consecutive PDUs MUST form a continuous - * non-overlapping range, and the PDUs MUST be sent in increasing offset - * order. - * - * The target may send several R2T PDUs. It therefore can have a number - * of pending data transfers. The number of outstanding R2T PDUs is - * limited by the value of the negotiated key MaxOutstandingR2T. Within - * a task, outstanding R2Ts MUST be fulfilled by the initiator in the - * order in which they were received. - * - * R2T PDUs MAY also be used to recover Data-Out PDUs. Such an R2T - * (Recovery-R2T) is generated by a target upon detecting the loss of - * one or more Data-Out PDUs due to: - * - * - Digest error - * - * - Sequence error - * - * - Sequence reception timeout - * - * A Recovery-R2T carries the next unused R2TSN but requests part of or - * the entire data burst that an earlier R2T (with a lower R2TSN) had - * already requested. - * - * DataSequenceInOrder governs the buffer offset ordering in consecutive - * R2Ts. If DataSequenceInOrder is Yes, then consecutive R2Ts MUST - * refer to continuous non-overlapping ranges, except for Recovery-R2Ts. - */ -typedef struct __attribute__((packed)) iscsi_r2t_packet { - /// Always 0x31 according to iSCSI specification. - uint8_t opcode; - - /// Reserved for future usage (always MUST be 0x80 for now). - int8_t flags; - - /// Reserved for future usage, always MUST be 0 for now. - uint16_t reserved; - - /// TotalAHSLength, MUST be 0 for this PDU. - uint8_t total_ahs_len; - - /// DataSegmentLength, MUST be 0 0 for this PDU. - uint8_t ds_len[3]; - - /// Logical Unit Number (LUN) or Reserved. - uint64_t lun; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /// Target Transfer Tag (TTT). - uint32_t target_xfer_tag; - - /// The StatSN field will contain the next StatSN. The StatSN for this connection is not advanced after this PDU is sent. - uint32_t stat_sn; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /// DataSN. - uint32_t data_sn; - - /// Ready To Transfer Sequence Number (R2TSN) is the R2T PDU input PDU number within the command identified by the Initiator Task Tag. For bidirectional commands, R2T and Data-In PDUs share the input PDU numbering sequence. - uint32_t r2t_sn; - - /** - * @brief Buffer Offset. - * - * The target therefore also specifies a buffer offset that indicates - * the point at which the data transfer should begin, relative to the - * beginning of the total data transfer. - */ - uint32_t buf_offset; - - /** - * @brief Desired Data Transfer Length. - * - * The target specifies how many bytes it wants the initiator to send - * because of this R2T PDU. The target may request the data from the - * initiator in several chunks, not necessarily in the original order of - * the data. The Desired Data Transfer Length MUST NOT be 0 and MUST NOT - * exceed MaxBurstLength. - */ - uint32_t des_data_xfer_len; - - /// Optional header digest. - iscsi_header_digest hdr_digest; -} iscsi_r2t_packet; - - -/** - * @brief SCSI Asynchronous Message Event: SCSI Async Event. - * - * A SCSI asynchronous event is reported in the sense data. - * Sense Data that accompanies the report, in the data - * segment, identifies the condition. The sending of a - * SCSI event ("asynchronous event reporting" in SCSI - * terminology) is dependent on the target support for SCSI - * asynchronous event reporting as indicated in the - * standard INQUIRY data. Its use may be enabled by - * parameters in the SCSI Control mode page. - */ -#define ISCSI_ASYNC_MSG_EVENT_SCSI_ASYNC_EVENT 0x00 - -/** - * @brief SCSI Asynchronous Message Event: Logout Request. - * - * The target requests Logout. This Async Message MUST - * be sent on the same connection as the one requesting - * to be logged out. The initiator MUST honor this request - * by issuing a Logout as early as possible but no later - * than Parameter3 seconds. The initiator MUST send a Logout - * with a reason code of "close the connection" OR "close the - * session" to close all the connections. Once this message is - * received, the initiator SHOULD NOT issue new iSCSI commands on - * the connection to be logged out. The target MAY reject any - * new I/O requests that it receives after this message with the - * reason code "Waiting for Logout". If the initiator does not - * log out in Parameter3 seconds, the target should send an Async - * PDU with iSCSI event code "Dropped the connection" if possible - * or simply terminate the transport connection. Parameter1 and - * Parameter2 are reserved. - */ -#define ISCSI_ASYNC_MSG_EVENT_LOGOUT_REQUEST 0x01 - -/** - * @brief SCSI Asynchronous Message Event: Connection Drop Notification. - * - * The target indicates that it will drop the connection. - * The Parameter1 field indicates the CID of the connection that - * is going to be dropped.\n - * The Parameter2 field (Time2Wait) indicates, in seconds, the - * minimum time to wait before attempting to reconnect or - * reassign.\n - * The Parameter3 field (Time2Retain) indicates the maximum time - * allowed to reassign commands after the initial wait (in - * Parameter2).\n - * If the initiator does not attempt to reconnect and/or reassign - * the outstanding commands within the time specified by - * Parameter3, or if Parameter3 is 0, the target will terminate - * all outstanding commands on this connection. In this case, no - * other responses should be expected from the target for the - * outstanding commands on this connection.\n - * A value of 0 for Parameter2 indicates that reconnect can be - * attempted immediately. - */ -#define ISCSI_ASYNC_MSG_EVENT_CONNECT_DROP_NOTIFY 0x02 - -/** - * @brief SCSI Asynchronous Message Event: Session Drop Notification. - * - * The target indicates that it will drop all the connections - * of this session.\n - * The Parameter1 field is reserved.\n - * The Parameter2 field (Time2Wait) indicates, in seconds, the - * minimum time to wait before attempting to reconnect.\n - * The Parameter3 field (Time2Retain) indicates the maximum time - * allowed to reassign commands after the initial wait (in - * Parameter2).\n - * If the initiator does not attempt to reconnect and/or reassign - * the outstanding commands within the time specified by - * Parameter3, or if Parameter3 is 0, the session is terminated.\n - * In this case, the target will terminate all outstanding - * commands in this session; no other responses should be - * expected from the target for the outstanding commands in this - * session. A value of 0 for Parameter2 indicates that reconnect - * can be attempted immediately. - */ -#define ISCSI_ASYNC_MSG_EVENT_SESSION_DROP_NOTIFY 0x03 - -/** - * @brief SCSI Asynchronous Message Event: Negotiation Request. - * - * The target requests parameter negotiation on this connection. - * The initiator MUST honor this request by issuing a Text - * Request (that can be empty) on the same connection as early - * as possible, but no later than Parameter3 seconds, unless a - * Text Request is already pending on the connection, or by - * issuing a Logout Request. If the initiator does not issue a - * Text Request, the target may reissue the Asynchronous Message - * requesting parameter negotiation. - */ -#define ISCSI_ASYNC_MSG_EVENT_NEGOTIATION_REQUEST 0x04 - -/** - * @brief SCSI Asynchronous Message Event: Task Termination. - * - * All active tasks for a LU with a matching LUN field in the - * Async Message PDU are being terminated. The receiving - * initiator iSCSI layer MUST respond to this message by - * taking the following steps, in order: - * - Stop Data-Out transfers on that connection for all active - * TTTs for the affected LUN quoted in the Async Message PDU. - * - Acknowledge the StatSN of the Async Message PDU via a - * NOP-Out PDU with ITT=0xFFFFFFFF (i.e., non-ping flavor), - * while copying the LUN field from the Async Message to - * NOP-Out. - * This value of AsyncEvent, however, MUST NOT be used on an - * iSCSI session unless the new TaskReporting text key was - * negotiated to FastAbort on the session. - */ -#define ISCSI_ASYNC_MSG_EVENT_TASK_TERMINATION 0x05 - -/// SCSI Asynchronous Message Event: First vendor-specific iSCSI event. The AsyncVCode details the vendor code, and data MAY accompany the report. -#define ISCSI_ASYNC_MSG_EVENT_VENDOR_FIRST 0xF8 - -/// SCSI Asynchronous Message Event: Last vendor-specific iSCSI event. The AsyncVCode details the vendor code, and data MAY accompany the report. -#define ISCSI_ASYNC_MSG_EVENT_VENDOR_LAST 0xFF - -/** - * @brief iSCSI Asynchronous Message packet data. - * - * An Asynchronous Message may be sent from the target to the initiator - * without corresponding to a particular command. The target specifies - * the reason for the event and sense data.\n - * Some Asynchronous Messages are strictly related to iSCSI, while - * others are related to SCSI - */ -typedef struct __attribute__((packed)) iscsi_async_msg_packet { - /// Always 0x32 according to iSCSI specification. - uint8_t opcode; - - /// Reserved for future usage (always MUST be 0x80 for now). - int8_t flags; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength, MUST be 0 for this PDU. - uint8_t total_ahs_len; - - /// DataSegmentLength, MUST be 0 0 for this PDU. - uint8_t ds_len[3]; - - /// The LUN field MUST be valid if AsyncEvent is 0. Otherwise, this field is reserved. - uint64_t lun; - - /// Tag (always 0xFFFFFFFF for now). - uint32_t tag; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved2; - - /** - * @brief StatSN. - * - * The StatSN counts this PDU as an acknowledgeable event (the StatSN is - * advanced), which allows for initiator and target state synchronization. - */ - uint32_t stat_sn; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /// AsyncEvent. - uint8_t async_event; - - /// AsyncVCode is a vendor-specific detail code that is only valid if the AsyncEvent field indicates a vendor-specific event. Otherwise, it is reserved. - uint8_t async_vcode; - - /// Parameter1 or Reserved. - uint16_t param_1; - - /// Parameter2 or Reserved. - uint16_t param_2; - - /// Parameter3 or Reserved. - uint16_t param_3; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved3; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /// Data segment. - iscsi_scsi_ds_cmd_data ds_cmd_data; - - /// Optional data digest. - iscsi_data_digest data_digest; -} iscsi_async_msg_packet; - - -/** * @brief Text Request flags: Continue. * * (C) When set to 1, this bit indicates that the text (set of key=value @@ -6287,106 +3933,100 @@ typedef struct __attribute__((packed)) iscsi_async_msg_packet { * implicitly terminated by the target. */ typedef struct __attribute__((packed)) iscsi_text_req_packet { - /// Always 0x04 according to iSCSI specification. - uint8_t opcode; - - /// Text request flags. - int8_t flags; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// Logical Unit Number (LUN) or Reserved. - uint64_t lun; - - /** - * @brief Initiator Task Tag (ITT). - * - * This is the initiator-assigned identifier for this Text Request. If - * the command is sent as part of a sequence of Text Requests and - * responses, the Initiator Task Tag MUST be the same for all the - * requests within the sequence (similar to linked SCSI commands). The - * I bit for all requests in a sequence also MUST be the same. - */ - uint32_t init_task_tag; - - /** - * @brief Target Transfer Tag (TTT). - * - * When the Target Transfer Tag is set to the reserved value 0xFFFFFFFF, - * it tells the target that this is a new request, and the target resets - * any internal state associated with the Initiator Task Tag (resets the - * current negotiation state).\n - * The target sets the Target Transfer Tag in a Text Response to a value - * other than the reserved value 0xFFFFFFFF whenever it indicates that - * it has more data to send or more operations to perform that are - * associated with the specified Initiator Task Tag. It MUST do so - * whenever it sets the F bit to 0 in the response. By copying the - * Target Transfer Tag from the response to the next Text Request, the - * initiator tells the target to continue the operation for the specific - * Initiator Task Tag. The initiator MUST ignore the Target Transfer - * Tag in the Text Response when the F bit is set to 1.\n - * This mechanism allows the initiator and target to transfer a large - * amount of textual data over a sequence of text-command/text-response - * exchanges or to perform extended negotiation sequences.\n - * If the Target Transfer Tag is not 0xFFFFFFFF, the LUN field MUST be - * sent by the target in the Text Response.\n - * A target MAY reset its internal negotiation state if an exchange is - * stalled by the initiator for a long time or if it is running out of - * resources.\n - * Long Text Responses are handled as shown in the following example:\n - * @verbatim - * I->T Text SendTargets=All (F = 1, TTT = 0xFFFFFFFF) - * T->I Text <part 1> (F = 0, TTT = 0x12345678) - * I->T Text <empty> (F = 1, TTT = 0x12345678) - * T->I Text <part 2> (F = 0, TTT = 0x12345678) - * I->T Text <empty> (F = 1, TTT = 0x12345678) - * ... - * T->I Text <part n> (F = 1, TTT = 0xFFFFFFFF) - * @endverbatim - */ - uint32_t target_xfer_tag; - - /// CmdSN. - uint32_t cmd_sn; - - /// ExpStatSN. - uint32_t exp_stat_sn; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2[2]; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /** - * @brief Data segment. - * - * The data lengths of a Text Request MUST NOT exceed the iSCSI target - * MaxRecvDataSegmentLength (a parameter that is negotiated per - * connection and per direction).\n - * A key=value pair can span Text Request or Text Response boundaries. - * A key=value pair can start in one PDU and continue on the next. In - * other words, the end of a PDU does not necessarily signal the end of - * a key=value pair.\n - * The target responds by sending its response back to the initiator. - * The response text format is similar to the request text format. The - * Text Response MAY refer to key=value pairs presented in an earlier - * Text Request, and the text in the request may refer to earlier - * responses.\n - * Text operations are usually meant for parameter setting/negotiations - * but can also be used to perform some long-lasting operations. - */ - iscsi_scsi_ds_cmd_data ds_cmd_data; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 0x04 according to iSCSI specification. + uint8_t opcode; + + /// Text request flags. + int8_t flags; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved; + + /// TotalAHSLength. + uint8_t total_ahs_len; + + /// DataSegmentLength. + uint8_t ds_len[3]; + + /// Logical Unit Number (LUN) or Reserved. + uint64_t lun; + + /** + * @brief Initiator Task Tag (ITT). + * + * This is the initiator-assigned identifier for this Text Request. If + * the command is sent as part of a sequence of Text Requests and + * responses, the Initiator Task Tag MUST be the same for all the + * requests within the sequence (similar to linked SCSI commands). The + * I bit for all requests in a sequence also MUST be the same. + */ + uint32_t init_task_tag; + + /** + * @brief Target Transfer Tag (TTT). + * + * When the Target Transfer Tag is set to the reserved value 0xFFFFFFFF, + * it tells the target that this is a new request, and the target resets + * any internal state associated with the Initiator Task Tag (resets the + * current negotiation state).\n + * The target sets the Target Transfer Tag in a Text Response to a value + * other than the reserved value 0xFFFFFFFF whenever it indicates that + * it has more data to send or more operations to perform that are + * associated with the specified Initiator Task Tag. It MUST do so + * whenever it sets the F bit to 0 in the response. By copying the + * Target Transfer Tag from the response to the next Text Request, the + * initiator tells the target to continue the operation for the specific + * Initiator Task Tag. The initiator MUST ignore the Target Transfer + * Tag in the Text Response when the F bit is set to 1.\n + * This mechanism allows the initiator and target to transfer a large + * amount of textual data over a sequence of text-command/text-response + * exchanges or to perform extended negotiation sequences.\n + * If the Target Transfer Tag is not 0xFFFFFFFF, the LUN field MUST be + * sent by the target in the Text Response.\n + * A target MAY reset its internal negotiation state if an exchange is + * stalled by the initiator for a long time or if it is running out of + * resources.\n + * Long Text Responses are handled as shown in the following example:\n + * @verbatim + * I->T Text SendTargets=All (F = 1, TTT = 0xFFFFFFFF) + * T->I Text <part 1> (F = 0, TTT = 0x12345678) + * I->T Text <empty> (F = 1, TTT = 0x12345678) + * T->I Text <part 2> (F = 0, TTT = 0x12345678) + * I->T Text <empty> (F = 1, TTT = 0x12345678) + * ... + * T->I Text <part n> (F = 1, TTT = 0xFFFFFFFF) + * @endverbatim + */ + uint32_t target_xfer_tag; + + /// CmdSN. + uint32_t cmd_sn; + + /// ExpStatSN. + uint32_t exp_stat_sn; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved2[2]; + + /** + * @brief Data segment. + * + * The data lengths of a Text Request MUST NOT exceed the iSCSI target + * MaxRecvDataSegmentLength (a parameter that is negotiated per + * connection and per direction).\n + * A key=value pair can span Text Request or Text Response boundaries. + * A key=value pair can start in one PDU and continue on the next. In + * other words, the end of a PDU does not necessarily signal the end of + * a key=value pair.\n + * The target responds by sending its response back to the initiator. + * The response text format is similar to the request text format. The + * Text Response MAY refer to key=value pairs presented in an earlier + * Text Request, and the text in the request may refer to earlier + * responses.\n + * Text operations are usually meant for parameter setting/negotiations + * but can also be used to perform some long-lasting operations. + */ + iscsi_scsi_ds_cmd_data ds_cmd_data; } iscsi_text_req_packet; @@ -6428,87 +4068,81 @@ typedef struct __attribute__((packed)) iscsi_text_req_packet { * of the Text Request. */ typedef struct __attribute__((packed)) iscsi_text_response_packet { - /// Always 0x24 according to iSCSI specification. - uint8_t opcode; - - /// Text response flags. - int8_t flags; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// Logical Unit Number (LUN) or Reserved. - uint64_t lun; - - /// The Initiator Task Tag matches the tag used in the initial Text Request. - uint32_t init_task_tag; - - /** - * @brief Target Transfer Tag (TTT). - * - * When a target has more work to do (e.g., cannot transfer all the - * remaining text data in a single Text Response or has to continue the - * negotiation) and has enough resources to proceed, it MUST set the - * Target Transfer Tag to a value other than the reserved value - * 0xFFFFFFFF. Otherwise, the Target Transfer Tag MUST be set to - * 0xFFFFFFFF.\n - * When the Target Transfer Tag is not 0xFFFFFFFF, the LUN field may be - * significant.\n - * The initiator MUST copy the Target Transfer Tag and LUN in its next - * request to indicate that it wants the rest of the data.\n - * When the target receives a Text Request with the Target Transfer Tag - * set to the reserved value 0xFFFFFFFF, it resets its internal - * information (resets state) associated with the given Initiator Task - * Tag (restarts the negotiation).\n - * When a target cannot finish the operation in a single Text Response - * and does not have enough resources to continue, it rejects the Text - * Request with the appropriate Reject code.\n - * A target may reset its internal state associated with an Initiator - * Task Tag (the current negotiation state) as expressed through the - * Target Transfer Tag if the initiator fails to continue the exchange - * for some time. The target may reject subsequent Text Requests with - * the Target Transfer Tag set to the "stale" value. - */ - uint32_t target_xfer_tag; - - /// StatSN. The target StatSN variable is advanced by each Text Response sent. - uint32_t stat_sn; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2[2]; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /** - * @brief Data segment. - * - * The data lengths of a Text Response MUST NOT exceed the iSCSI - * initiator MaxRecvDataSegmentLength (a parameter that is negotiated - * per connection and per direction).\n - * The text in the Text Response Data is governed by the same rules as - * the text in the Text Request Data.\n - * Although the initiator is the requesting party and controls the - * request-response initiation and termination, the target can offer - * key=value pairs of its own as part of a sequence and not only in - * response to the initiator. - */ - iscsi_scsi_ds_cmd_data ds_cmd_data; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 0x24 according to iSCSI specification. + uint8_t opcode; + + /// Text response flags. + int8_t flags; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved; + + /// TotalAHSLength. + uint8_t total_ahs_len; + + /// DataSegmentLength. + uint8_t ds_len[3]; + + /// Logical Unit Number (LUN) or Reserved. + uint64_t lun; + + /// The Initiator Task Tag matches the tag used in the initial Text Request. + uint32_t init_task_tag; + + /** + * @brief Target Transfer Tag (TTT). + * + * When a target has more work to do (e.g., cannot transfer all the + * remaining text data in a single Text Response or has to continue the + * negotiation) and has enough resources to proceed, it MUST set the + * Target Transfer Tag to a value other than the reserved value + * 0xFFFFFFFF. Otherwise, the Target Transfer Tag MUST be set to + * 0xFFFFFFFF.\n + * When the Target Transfer Tag is not 0xFFFFFFFF, the LUN field may be + * significant.\n + * The initiator MUST copy the Target Transfer Tag and LUN in its next + * request to indicate that it wants the rest of the data.\n + * When the target receives a Text Request with the Target Transfer Tag + * set to the reserved value 0xFFFFFFFF, it resets its internal + * information (resets state) associated with the given Initiator Task + * Tag (restarts the negotiation).\n + * When a target cannot finish the operation in a single Text Response + * and does not have enough resources to continue, it rejects the Text + * Request with the appropriate Reject code.\n + * A target may reset its internal state associated with an Initiator + * Task Tag (the current negotiation state) as expressed through the + * Target Transfer Tag if the initiator fails to continue the exchange + * for some time. The target may reject subsequent Text Requests with + * the Target Transfer Tag set to the "stale" value. + */ + uint32_t target_xfer_tag; + + /// StatSN. The target StatSN variable is advanced by each Text Response sent. + uint32_t stat_sn; + + /// ExpCmdSN. + uint32_t exp_cmd_sn; + + /// MaxCmdSN. + uint32_t max_cmd_sn; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved2[2]; + + /** + * @brief Data segment. + * + * The data lengths of a Text Response MUST NOT exceed the iSCSI + * initiator MaxRecvDataSegmentLength (a parameter that is negotiated + * per connection and per direction).\n + * The text in the Text Response Data is governed by the same rules as + * the text in the Text Request Data.\n + * Although the initiator is the requesting party and controls the + * request-response initiation and termination, the target can offer + * key=value pairs of its own as part of a sequence and not only in + * response to the initiator. + */ + iscsi_scsi_ds_cmd_data ds_cmd_data; } iscsi_text_response_packet; @@ -6585,1735 +4219,20 @@ typedef struct __attribute__((packed)) iscsi_text_response_packet { * MUST also be persistent over power cycles, reboot, card swap, etc. */ typedef struct __attribute__((packed)) iscsi_isid { - /// Meaning depends on T bit, either 22-bit OUI or reserved. - uint8_t a; + /// Meaning depends on T bit, either 22-bit OUI or reserved. + uint8_t a; - /// Meaning depends on T bit, either 22-bit OUI, EN (IANA Enterprise Number) or random. - uint16_t b; + /// Meaning depends on T bit, either 22-bit OUI, EN (IANA Enterprise Number) or random. + uint16_t b; - /// Meaning depends on T bit, either 24-bit Qualifier, EN (IANA Enterprise Number) or random. - uint8_t c; + /// Meaning depends on T bit, either 24-bit Qualifier, EN (IANA Enterprise Number) or random. + uint8_t c; - /// Meaning depends on T bit, either 24-bit Qualifier or Qualifier. - uint16_t d; + /// Meaning depends on T bit, either 24-bit Qualifier or Qualifier. + uint16_t d; } iscsi_isid; -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Session type. - * - * @verbatim - * Use: LO, Declarative, Any-Stage - * Senders: Initiator - * Scope: SW - * SessionType=<Discovery|Normal> - * Default is Normal. - * @endverbatim - * The initiator indicates the type of session it wants to create. The - * target can either accept it or reject it.\n - * A Discovery session indicates to the target that the only purpose of - * this session is discovery. The only requests a target accepts in - * this type of session are a Text Request with a SendTargets key and a - * Logout Request with reason "close the session".\n - * The Discovery session implies MaxConnections = 1 and overrides both - * the default and an explicit setting. ErrorRecoveryLevel MUST be 0 - * (zero) for Discovery sessions.\n - * Depending on the type of session, a target may decide on resources to - * allocate, the security to enforce, etc., for the session. If the - * SessionType key is thus going to be offered as "Discovery", it SHOULD - * be offered in the initial Login Request by the initiator. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_SESSION_TYPE ((const uint8_t *) "SessionType\0\0\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Initiator name. - * - * @verbatim - * Use: IO, Declarative, Any-Stage - * Senders: Initiator - * Scope: SW - * InitiatorName=<iSCSI-name-value> - * Examples: - * InitiatorName=iqn.1992-04.de.uni-freiburg.bwlehrpool:qcow2.5003 - * InitiatorName=iqn.2001-02.de.uni-freiburg.matrix:basty.eduroam - * InitiatorName=naa.52004567BA64678D - * @endverbatim - * The initiator of the TCP connection MUST provide this key to the - * remote endpoint at the first login of the Login Phase for every - * connection. The InitiatorName key enables the initiator to identify - * itself to the remote endpoint.\n - * The InitiatorName MUST NOT be redeclared within the Login Phase. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_INITIATOR_NAME ((const uint8_t *) "InitiatorName\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Target name. - * - * @verbatim - * Use: IO by initiator, FFPO by target - only as response to a - * SendTargets, Declarative, Any-Stage - * Senders: Initiator and target - * Scope: SW - * TargetName=<iSCSI-name-value> - * Examples: - * TargetName=iqn.1993-11.de.uni-freiburg:diskarrays.sn.5003 - * TargetName=eui.020000023B040506 - * TargetName=naa.62004567BA64678D0123456789ABCDEF - * @endverbatim - * The initiator of the TCP connection MUST provide this key to the - * remote endpoint in the first Login Request if the initiator is not - * establishing a Discovery session. The iSCSI Target Name specifies - * the worldwide unique name of the target.\n - * The TargetName key may also be returned by the SendTargets Text - * Request (which is its only use when issued by a target).\n - * The TargetName MUST NOT be redeclared within the Login Phase. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_NAME ((const uint8_t *) "TargetName\0\0\0\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Target address. - * - * @verbatim - * Use: ALL, Declarative, Any-Stage - * Senders: Target - * Scope: SW - * TargetAddress=domainname[:port][,portal-group-tag] - * @endverbatim - * The domainname can be specified as either a DNS host name, a dotted- - * decimal IPv4 address, or a bracketed IPv6 address as specified in - * RFC3986.\n - * If the TCP port is not specified, it is assumed to be the IANA- - * assigned default port for iSCSI.\n - * If the TargetAddress is returned as the result of a redirect status - * in a Login Response, the comma and portal-group-tag MUST be omitted. - * If the TargetAddress is returned within a SendTargets response, the - * portal-group-tag MUST be included.\n - * @verbatim - * Examples: - * TargetAddress=10.0.0.1:5003,1 - * TargetAddress=[1080:0:0:0:8:800:200C:417A],65 - * TargetAddress=[1080::8:800:200C:417A]:5003,1 - * TargetAddress=gitlab.uni-freiburg.de,443 - * @endverbatim - * The formats for the port and portal-group-tag are the same as the one - * specified in TargetPortalGroupTag. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ADDRESS ((const uint8_t *) "TargetAddress\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Initiator alias. - * - * @verbatim - * Use: ALL, Declarative, Any-Stage - * Senders: Initiator - * Scope: SW - * InitiatorAlias=<iSCSI-local-name-value> - * Examples: - * InitiatorAlias=Web Server 5 - * InitiatorAlias=matrix.uni-freiburg.de - * InitiatorAlias=Matrix Server - * @endverbatim - * If an initiator has been configured with a human-readable name or - * description, it SHOULD be communicated to the target during a Login - * Request PDU. If not, the host name can be used instead. This string - * is not used as an identifier, nor is it meant to be used for - * authentication or authorization decisions. It can be displayed by - * the target's user interface in a list of initiators to which it is - * connected. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_INITIATOR_ALIAS ((const uint8_t *) "InitiatorAlias\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Target alias. - * - * @verbatim - * Use: ALL, Declarative, Any-Stage - * Senders: Target - * Scope: SW - * TargetAlias=<iSCSI-local-name-value> - * Examples: - * TargetAlias=Bob-s Disk - * TargetAlias=Database Server 1 Log Disk - * TargetAlias=Web Server 3 Disk 20 - * @endverbatim - * If a target has been configured with a human-readable name or - * description, this name SHOULD be communicated to the initiator during - * a Login Response PDU if SessionType=Normal. This string is not used - * as an identifier, nor is it meant to be used for authentication or - * authorization decisions. It can be displayed by the initiator's user - * interface in a list of targets to which it is connected. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_ALIAS ((const uint8_t *) "TargetAlias\0\0\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Target portal group tag. - * - * @verbatim - * Use: IO by target, Declarative, Any-Stage - * Senders: Target - * Scope: SW - * TargetPortalGroupTag=<16-bit-binary-value> - * Example: - * TargetPortalGroupTag=1 - * @endverbatim - * The TargetPortalGroupTag key is a 16-bit binary-value that uniquely - * identifies a portal group within an iSCSI target node. This key - * carries the value of the tag of the portal group that is servicing - * the Login Request. The iSCSI target returns this key to the - * initiator in the Login Response PDU to the first Login Request PDU - * that has the C bit set to 0 when TargetName is given by the - * initiator.\n - * SAM2 notes in its informative text that the TPGT value should be - * non-zero; note that this is incorrect. A zero value is allowed as a - * legal value for the TPGT. This discrepancy currently stands - * corrected in SAM4. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_TARGET_PORTAL_GROUP_TAG ((const uint8_t *) "TargetPortalGroupTag\0\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Authentication method. - * - * @verbatim - * Use: During Login - Security Negotiation - * Senders: Initiator and target - * Scope: connection - * AuthMethod = <list-of-values> - * @endverbatim - * The main item of security negotiation is the authentication method - * (AuthMethod).\n - * The authentication methods that can be used (appear in the list-of- - * values) are either vendor-unique methods or those listed in the - * following table: - * Name | Description - * :--- | :--------------------------------------------------------------- - * KRB5 | Kerberos V5 - defined in RFC4120 - * SRP | Secure Remote Password - defined in RFC2945 - * CHAP | Challenge Handshake Authentication Protocol - defined in RFC1994 - * None | No authentication - * - * The AuthMethod selection is followed by an "authentication exchange" - * specific to the authentication method selected.\n - * The authentication method proposal may be made by either the - * initiator or the target. However, the initiator MUST make the first - * step specific to the selected authentication method as soon as it is - * selected. It follows that if the target makes the authentication - * method proposal, the initiator sends the first key(s) of the exchange - * together with its authentication method selection.\n - * The authentication exchange authenticates the initiator to the target - * and, optionally, the target to the initiator. Authentication is - * OPTIONAL to use but MUST be supported by the target and initiator. - * The initiator and target MUST implement CHAP. All other - * authentication methods are OPTIONAL.\n - * Private or public extension algorithms MAY also be negotiated for - * authentication methods. Whenever a private or public extension - * algorithm is part of the default offer (the offer made in the absence - * of explicit administrative action), the implementer MUST ensure that - * CHAP is listed as an alternative in the default offer and "None" is - * not part of the default offer.\n - * Extension authentication methods MUST be named using one of the - * following two formats: - * -# Z-reversed.vendor.dns_name.do_something= - * -# New public key with no name prefix constraints - * - * Authentication methods named using the Z- format are used as private - * extensions. New public keys must be registered with IANA using the - * IETF Review process RFC5226. New public extensions for - * authentication methods MUST NOT use the Z# name prefix.\n - * For all of the public or private extension authentication methods, - * the method-specific keys MUST conform to the format specified for - * standard-label.\n - * To identify the vendor for private extension authentication methods, - * we suggest using the reversed DNS-name as a prefix to the proper - * digest names.\n - * The part of digest-name following Z- MUST conform to the format for - * standard-label.\n - * Support for public or private extension authentication methods is - * OPTIONAL. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD ((const uint8_t *) "AuthMethod\0\0\0\0\0") - - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Kerberos V5 (KRB5): KRB_AP_REQ. - * - * For KRB5 (Kerberos V5) (see RFC4120 and RFC1964), the initiator MUST use: - * @verbatim - * KRB_AP_REQ=<KRB_AP_REQ> - * @endverbatim - * where KRB_AP_REQ is the client message as defined in RFC4120. - * The default principal name assumed by an iSCSI initiator or target - * (prior to any administrative configuration action) MUST be the iSCSI - * Initiator Name or iSCSI Target Name, respectively, prefixed by the - * string "iscsi/".\n - * If the initiator authentication fails, the target MUST respond with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator has selected the mutual authentication option (by setting - * MUTUAL-REQUIRED in the ap-options field of the KRB_AP_REQ), the - * target MUST reply with: - * @verbatim - * KRB_AP_REP=<KRB_AP_REP> - * @endverbatim - * where KRB_AP_REP is the server's response message as defined in - * RFC4120.\n - * If mutual authentication was selected and target authentication - * fails, the initiator MUST close the connection.\n - * KRB_AP_REQ and KRB_AP_REP are binary-values, and their binary length - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 65536 bytes. Hex or Base64 encoding - * may be used for KRB_AP_REQ and KRB_AP_REP. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_KRB_AP_REQ ((const uint8_t *) "KRB_AP_REQ\0\0\0\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Kerberos V5 (KRB5): KRB_AP_REP. - * - * For KRB5 (Kerberos V5) (see RFC4120 and RFC1964), the initiator MUST use: - * @verbatim - * KRB_AP_REQ=<KRB_AP_REQ> - * @endverbatim - * where KRB_AP_REQ is the client message as defined in RFC4120. - * The default principal name assumed by an iSCSI initiator or target - * (prior to any administrative configuration action) MUST be the iSCSI - * Initiator Name or iSCSI Target Name, respectively, prefixed by the - * string "iscsi/".\n - * If the initiator authentication fails, the target MUST respond with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator has selected the mutual authentication option (by setting - * MUTUAL-REQUIRED in the ap-options field of the KRB_AP_REQ), the - * target MUST reply with: - * @verbatim - * KRB_AP_REP=<KRB_AP_REP> - * @endverbatim - * where KRB_AP_REP is the server's response message as defined in - * RFC4120.\n - * If mutual authentication was selected and target authentication - * fails, the initiator MUST close the connection.\n - * KRB_AP_REQ and KRB_AP_REP are binary-values, and their binary length - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 65536 bytes. Hex or Base64 encoding - * may be used for KRB_AP_REQ and KRB_AP_REP. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_KRB_AP_REP ((const uint8_t *) "KRB_AP_REP\0\0\0\0\0") - - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Secure Remote Password (SRP): SRP_U. - * - * For SRP RFC2945, the initiator MUST use: - * @verbatim - * SRP_U=<U> TargetAuth=Yes or TargetAuth=No - * @endverbatim - * The target MUST answer with a Login reject with the "Authorization - * Failure" status or reply with: - * @verbatim - * SRP_GROUP=<G1,G2...> SRP_s=<s> - * @endverbatim - * where G1,G2... are proposed groups, in order of preference. - * The initiator MUST either close the connection or continue with: - * @verbatim - * SRP_A=<A> - * SRP_GROUP=<G> - * @endverbatim - * where G is one of G1,G2... that were proposed by the target. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * SRP_B=<B> - * @endverbatim - * The initiator MUST close the connection or continue with: - * @verbatim - * SRP_M=<M> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator sent TargetAuth=Yes in the first message (requiring target - * authentication), the target MUST reply with: - * @verbatim - * SRP_HM=<H(A | M | K)> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where U, s, A, B, M, and H(A | M | K) are defined in RFC2945 (using - * the SHA1 hash function, such as SRP-SHA1) and - * G,Gn ("Gn" stands for G1,G2...) are identifiers of SRP groups - * specified in RFC3723.\n - * G, Gn, and U are text strings; s,A,B,M, and H(A | M | K) are - * binary-values. The length of s,A,B,M and H(A | M | K) in binary form - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 1024 bytes. Hex or Base64 encoding may - * be used for s,A,B,M and H(A | M | K).\n - * For the SRP_GROUP, all the groups specified in RFC3723 up to - * 1536 bits (i.e. SRP-768, SRP-1024, SRP-1280, SRP-1536) must be - * supported by initiators and targets. To guarantee interoperability, - * targets MUST always offer "SRP-1536" as one of the proposed groups. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_SRP_SRP_U ((const uint8_t *) "SRP_U\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Secure Remote Password (SRP): SRP_GROUP. - * - * For SRP RFC2945, the initiator MUST use: - * @verbatim - * SRP_U=<U> TargetAuth=Yes or TargetAuth=No - * @endverbatim - * The target MUST answer with a Login reject with the "Authorization - * Failure" status or reply with: - * @verbatim - * SRP_GROUP=<G1,G2...> SRP_s=<s> - * @endverbatim - * where G1,G2... are proposed groups, in order of preference. - * The initiator MUST either close the connection or continue with: - * @verbatim - * SRP_A=<A> - * SRP_GROUP=<G> - * @endverbatim - * where G is one of G1,G2... that were proposed by the target. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * SRP_B=<B> - * @endverbatim - * The initiator MUST close the connection or continue with: - * @verbatim - * SRP_M=<M> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator sent TargetAuth=Yes in the first message (requiring target - * authentication), the target MUST reply with: - * @verbatim - * SRP_HM=<H(A | M | K)> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where U, s, A, B, M, and H(A | M | K) are defined in RFC2945 (using - * the SHA1 hash function, such as SRP-SHA1) and - * G,Gn ("Gn" stands for G1,G2...) are identifiers of SRP groups - * specified in RFC3723.\n - * G, Gn, and U are text strings; s,A,B,M, and H(A | M | K) are - * binary-values. The length of s,A,B,M and H(A | M | K) in binary form - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 1024 bytes. Hex or Base64 encoding may - * be used for s,A,B,M and H(A | M | K).\n - * For the SRP_GROUP, all the groups specified in RFC3723 up to - * 1536 bits (i.e. SRP-768, SRP-1024, SRP-1280, SRP-1536) must be - * supported by initiators and targets. To guarantee interoperability, - * targets MUST always offer "SRP-1536" as one of the proposed groups. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_SRP_SRP_GROUP ((const uint8_t *) "SRP_GROUP\0\0\0\0\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Secure Remote Password (SRP): SRP_A. - * - * For SRP RFC2945, the initiator MUST use: - * @verbatim - * SRP_U=<U> TargetAuth=Yes or TargetAuth=No - * @endverbatim - * The target MUST answer with a Login reject with the "Authorization - * Failure" status or reply with: - * @verbatim - * SRP_GROUP=<G1,G2...> SRP_s=<s> - * @endverbatim - * where G1,G2... are proposed groups, in order of preference. - * The initiator MUST either close the connection or continue with: - * @verbatim - * SRP_A=<A> - * SRP_GROUP=<G> - * @endverbatim - * where G is one of G1,G2... that were proposed by the target. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * SRP_B=<B> - * @endverbatim - * The initiator MUST close the connection or continue with: - * @verbatim - * SRP_M=<M> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator sent TargetAuth=Yes in the first message (requiring target - * authentication), the target MUST reply with: - * @verbatim - * SRP_HM=<H(A | M | K)> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where U, s, A, B, M, and H(A | M | K) are defined in RFC2945 (using - * the SHA1 hash function, such as SRP-SHA1) and - * G,Gn ("Gn" stands for G1,G2...) are identifiers of SRP groups - * specified in RFC3723.\n - * G, Gn, and U are text strings; s,A,B,M, and H(A | M | K) are - * binary-values. The length of s,A,B,M and H(A | M | K) in binary form - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 1024 bytes. Hex or Base64 encoding may - * be used for s,A,B,M and H(A | M | K).\n - * For the SRP_GROUP, all the groups specified in RFC3723 up to - * 1536 bits (i.e. SRP-768, SRP-1024, SRP-1280, SRP-1536) must be - * supported by initiators and targets. To guarantee interoperability, - * targets MUST always offer "SRP-1536" as one of the proposed groups. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_SRP_SRP_A ((const uint8_t *) "SRP_A\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Secure Remote Password (SRP): SRP_B. - * - * For SRP RFC2945, the initiator MUST use: - * @verbatim - * SRP_U=<U> TargetAuth=Yes or TargetAuth=No - * @endverbatim - * The target MUST answer with a Login reject with the "Authorization - * Failure" status or reply with: - * @verbatim - * SRP_GROUP=<G1,G2...> SRP_s=<s> - * @endverbatim - * where G1,G2... are proposed groups, in order of preference. - * The initiator MUST either close the connection or continue with: - * @verbatim - * SRP_A=<A> - * SRP_GROUP=<G> - * @endverbatim - * where G is one of G1,G2... that were proposed by the target. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * SRP_B=<B> - * @endverbatim - * The initiator MUST close the connection or continue with: - * @verbatim - * SRP_M=<M> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator sent TargetAuth=Yes in the first message (requiring target - * authentication), the target MUST reply with: - * @verbatim - * SRP_HM=<H(A | M | K)> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where U, s, A, B, M, and H(A | M | K) are defined in RFC2945 (using - * the SHA1 hash function, such as SRP-SHA1) and - * G,Gn ("Gn" stands for G1,G2...) are identifiers of SRP groups - * specified in RFC3723.\n - * G, Gn, and U are text strings; s,A,B,M, and H(A | M | K) are - * binary-values. The length of s,A,B,M and H(A | M | K) in binary form - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 1024 bytes. Hex or Base64 encoding may - * be used for s,A,B,M and H(A | M | K).\n - * For the SRP_GROUP, all the groups specified in RFC3723 up to - * 1536 bits (i.e. SRP-768, SRP-1024, SRP-1280, SRP-1536) must be - * supported by initiators and targets. To guarantee interoperability, - * targets MUST always offer "SRP-1536" as one of the proposed groups. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_SRP_SRP_B ((const uint8_t *) "SRP_B\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Secure Remote Password (SRP): SRP_M. - * - * For SRP RFC2945, the initiator MUST use: - * @verbatim - * SRP_U=<U> TargetAuth=Yes or TargetAuth=No - * @endverbatim - * The target MUST answer with a Login reject with the "Authorization - * Failure" status or reply with: - * @verbatim - * SRP_GROUP=<G1,G2...> SRP_s=<s> - * @endverbatim - * where G1,G2... are proposed groups, in order of preference. - * The initiator MUST either close the connection or continue with: - * @verbatim - * SRP_A=<A> - * SRP_GROUP=<G> - * @endverbatim - * where G is one of G1,G2... that were proposed by the target. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * SRP_B=<B> - * @endverbatim - * The initiator MUST close the connection or continue with: - * @verbatim - * SRP_M=<M> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator sent TargetAuth=Yes in the first message (requiring target - * authentication), the target MUST reply with: - * @verbatim - * SRP_HM=<H(A | M | K)> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where U, s, A, B, M, and H(A | M | K) are defined in RFC2945 (using - * the SHA1 hash function, such as SRP-SHA1) and - * G,Gn ("Gn" stands for G1,G2...) are identifiers of SRP groups - * specified in RFC3723.\n - * G, Gn, and U are text strings; s,A,B,M, and H(A | M | K) are - * binary-values. The length of s,A,B,M and H(A | M | K) in binary form - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 1024 bytes. Hex or Base64 encoding may - * be used for s,A,B,M and H(A | M | K).\n - * For the SRP_GROUP, all the groups specified in RFC3723 up to - * 1536 bits (i.e. SRP-768, SRP-1024, SRP-1280, SRP-1536) must be - * supported by initiators and targets. To guarantee interoperability, - * targets MUST always offer "SRP-1536" as one of the proposed groups. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_SRP_SRP_M ((const uint8_t *) "SRP_M\0\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Secure Remote Password (SRP): SRP_HM. - * - * For SRP RFC2945, the initiator MUST use: - * @verbatim - * SRP_U=<U> TargetAuth=Yes or TargetAuth=No - * @endverbatim - * The target MUST answer with a Login reject with the "Authorization - * Failure" status or reply with: - * @verbatim - * SRP_GROUP=<G1,G2...> SRP_s=<s> - * @endverbatim - * where G1,G2... are proposed groups, in order of preference. - * The initiator MUST either close the connection or continue with: - * @verbatim - * SRP_A=<A> - * SRP_GROUP=<G> - * @endverbatim - * where G is one of G1,G2... that were proposed by the target. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * SRP_B=<B> - * @endverbatim - * The initiator MUST close the connection or continue with: - * @verbatim - * SRP_M=<M> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator sent TargetAuth=Yes in the first message (requiring target - * authentication), the target MUST reply with: - * @verbatim - * SRP_HM=<H(A | M | K)> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where U, s, A, B, M, and H(A | M | K) are defined in RFC2945 (using - * the SHA1 hash function, such as SRP-SHA1) and - * G,Gn ("Gn" stands for G1,G2...) are identifiers of SRP groups - * specified in RFC3723.\n - * G, Gn, and U are text strings; s,A,B,M, and H(A | M | K) are - * binary-values. The length of s,A,B,M and H(A | M | K) in binary form - * (not the length of the character string that represents them in - * encoded form) MUST NOT exceed 1024 bytes. Hex or Base64 encoding may - * be used for s,A,B,M and H(A | M | K).\n - * For the SRP_GROUP, all the groups specified in RFC3723 up to - * 1536 bits (i.e. SRP-768, SRP-1024, SRP-1280, SRP-1536) must be - * supported by initiators and targets. To guarantee interoperability, - * targets MUST always offer "SRP-1536" as one of the proposed groups. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_SRP_SRP_HM ((const uint8_t *) "SRP_HM\0") - - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Challenge Handshake Authentication Protocol (CHAP): CHAP_A. - * - * For CHAP RFC1994, the initiator MUST use: - * @verbatim - * CHAP_A=<A1,A2...> - * @endverbatim - * where A1,A2... are proposed algorithms, in order of preference. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * CHAP_A=<A> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * where A is one of A1,A2... that were proposed by the initiator. - * The initiator MUST continue with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * or, if it requires target authentication, with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator required target authentication, the target MUST either - * answer with a Login reject with "Authentication Failure" or reply - * with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where N, (A,A1,A2), I, C, and R are (correspondingly) the Name, - * Algorithm, Identifier, Challenge, and Response as defined in - * RFC1994.\n - * N is a text string; A,A1,A2, and I are numbers; C and R are - * binary-values. Their binary length (not the length of the character - * string that represents them in encoded form) MUST NOT exceed - * 1024 bytes. Hex or Base64 encoding may be used for C and R.\n - * For the Algorithm, as stated in [RFC1994], one value is required to - * be implemented: - * @verbatim - * 5 (CHAP with MD5) - * @endverbatim - * To guarantee interoperability, initiators MUST always offer it as one - * of the proposed algorithms. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_A ((const uint8_t *) "CHAP_A\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Challenge Handshake Authentication Protocol (CHAP): CHAP_I. - * - * For CHAP RFC1994, the initiator MUST use: - * @verbatim - * CHAP_A=<A1,A2...> - * @endverbatim - * where A1,A2... are proposed algorithms, in order of preference. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * CHAP_A=<A> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * where A is one of A1,A2... that were proposed by the initiator. - * The initiator MUST continue with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * or, if it requires target authentication, with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator required target authentication, the target MUST either - * answer with a Login reject with "Authentication Failure" or reply - * with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where N, (A,A1,A2), I, C, and R are (correspondingly) the Name, - * Algorithm, Identifier, Challenge, and Response as defined in - * RFC1994.\n - * N is a text string; A,A1,A2, and I are numbers; C and R are - * binary-values. Their binary length (not the length of the character - * string that represents them in encoded form) MUST NOT exceed - * 1024 bytes. Hex or Base64 encoding may be used for C and R.\n - * For the Algorithm, as stated in [RFC1994], one value is required to - * be implemented: - * @verbatim - * 5 (CHAP with MD5) - * @endverbatim - * To guarantee interoperability, initiators MUST always offer it as one - * of the proposed algorithms. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_I ((const uint8_t *) "CHAP_I\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Challenge Handshake Authentication Protocol (CHAP): CHAP_C. - * - * For CHAP RFC1994, the initiator MUST use: - * @verbatim - * CHAP_A=<A1,A2...> - * @endverbatim - * where A1,A2... are proposed algorithms, in order of preference. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * CHAP_A=<A> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * where A is one of A1,A2... that were proposed by the initiator. - * The initiator MUST continue with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * or, if it requires target authentication, with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator required target authentication, the target MUST either - * answer with a Login reject with "Authentication Failure" or reply - * with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where N, (A,A1,A2), I, C, and R are (correspondingly) the Name, - * Algorithm, Identifier, Challenge, and Response as defined in - * RFC1994.\n - * N is a text string; A,A1,A2, and I are numbers; C and R are - * binary-values. Their binary length (not the length of the character - * string that represents them in encoded form) MUST NOT exceed - * 1024 bytes. Hex or Base64 encoding may be used for C and R.\n - * For the Algorithm, as stated in [RFC1994], one value is required to - * be implemented: - * @verbatim - * 5 (CHAP with MD5) - * @endverbatim - * To guarantee interoperability, initiators MUST always offer it as one - * of the proposed algorithms. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_C ((const uint8_t *) "CHAP_C\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Challenge Handshake Authentication Protocol (CHAP): CHAP_N. - * - * For CHAP RFC1994, the initiator MUST use: - * @verbatim - * CHAP_A=<A1,A2...> - * @endverbatim - * where A1,A2... are proposed algorithms, in order of preference. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * CHAP_A=<A> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * where A is one of A1,A2... that were proposed by the initiator. - * The initiator MUST continue with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * or, if it requires target authentication, with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator required target authentication, the target MUST either - * answer with a Login reject with "Authentication Failure" or reply - * with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where N, (A,A1,A2), I, C, and R are (correspondingly) the Name, - * Algorithm, Identifier, Challenge, and Response as defined in - * RFC1994.\n - * N is a text string; A,A1,A2, and I are numbers; C and R are - * binary-values. Their binary length (not the length of the character - * string that represents them in encoded form) MUST NOT exceed - * 1024 bytes. Hex or Base64 encoding may be used for C and R.\n - * For the Algorithm, as stated in [RFC1994], one value is required to - * be implemented: - * @verbatim - * 5 (CHAP with MD5) - * @endverbatim - * To guarantee interoperability, initiators MUST always offer it as one - * of the proposed algorithms. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_N ((const uint8_t *) "CHAP_N\0") - -/** - * @brief Key used during SecurityNegotiation stage of Login Phase: Challenge Handshake Authentication Protocol (CHAP): CHAP_R. - * - * For CHAP RFC1994, the initiator MUST use: - * @verbatim - * CHAP_A=<A1,A2...> - * @endverbatim - * where A1,A2... are proposed algorithms, in order of preference. - * The target MUST answer with a Login reject with the "Authentication - * Failure" status or reply with: - * @verbatim - * CHAP_A=<A> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * where A is one of A1,A2... that were proposed by the initiator. - * The initiator MUST continue with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * or, if it requires target authentication, with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * CHAP_I=<I> - * CHAP_C=<C> - * @endverbatim - * If the initiator authentication fails, the target MUST answer with a - * Login reject with "Authentication Failure" status. Otherwise, if the - * initiator required target authentication, the target MUST either - * answer with a Login reject with "Authentication Failure" or reply - * with: - * @verbatim - * CHAP_N=<N> - * CHAP_R=<R> - * @endverbatim - * If the target authentication fails, the initiator MUST close the - * connection:\n - * where N, (A,A1,A2), I, C, and R are (correspondingly) the Name, - * Algorithm, Identifier, Challenge, and Response as defined in - * RFC1994.\n - * N is a text string; A,A1,A2, and I are numbers; C and R are - * binary-values. Their binary length (not the length of the character - * string that represents them in encoded form) MUST NOT exceed - * 1024 bytes. Hex or Base64 encoding may be used for C and R.\n - * For the Algorithm, as stated in [RFC1994], one value is required to - * be implemented: - * @verbatim - * 5 (CHAP with MD5) - * @endverbatim - * To guarantee interoperability, initiators MUST always offer it as one - * of the proposed algorithms. - */ -#define ISCSI_LOGIN_AUTH_SECURITY_TEXT_KEY_AUTH_METHOD_CHAP_CHAP_R ((const uint8_t *) "CHAP_R\0") - -/* Login/Text Operational Text Keys - - Some session-specific parameters MUST only be carried on the leading - connection and cannot be changed after the leading connection login - (e.g., MaxConnections - the maximum number of connections). This - holds for a single connection session with regard to connection - restart. The keys that fall into this category have the "use: LO" - (Leading Only). - - Keys that can only be used during login have the "use: IO" - (Initialize Only), while those that can be used in both the Login - Phase and Full Feature Phase have the "use: ALL". - - Keys that can only be used during the Full Feature Phase use FFPO - (Full Feature Phase Only). - - Keys marked as Any-Stage may also appear in the SecurityNegotiation - stage, while all other keys described in this section are - operational keys. - - Keys that do not require an answer are marked as Declarative. - - Key scope is indicated as session-wide (SW) or connection-only (CO). - - "Result function", wherever mentioned, states the function that can - be applied to check the validity of the responder selection. - "Minimum" means that the selected value cannot exceed the offered - value. "Maximum" means that the selected value cannot be lower than - the offered value. "AND" means that the selected value must be a - possible result of a Boolean "and" function with an arbitrary Boolean - value (e.g., if the offered value is No the selected value must be - No). "OR" means that the selected value must be a possible result of - a Boolean "or" function with an arbitrary Boolean value (e.g., if the - offered value is Yes the selected value must be Yes). -*/ - -/** - * @brief Login/Text Operational Session Text Key: Header digest. - * - * @verbatim - * Use: IO - * Senders: Initiator and target - * Scope: CO - * HeaderDigest = <list-of-values> - * Default is None for HeaderDigest. - * @endverbatim - * Digests enable the checking of end-to-end, non-cryptographic data - * integrity beyond the integrity checks provided by the link layers and - * the covering of the whole communication path, including all elements - * that may change the network-level PDUs, such as routers, switches, - * and proxies.\n - * The following table lists cyclic integrity checksums that can be - * negotiated for the digests and MUST be implemented by every iSCSI - * initiator and target. These digest options only have error detection - * significance. - * Name | Description | Generator - * :----- | :---------- | :---------- - * CRC32C | 32-bit CRC | 0x11EDC6F41 - * None | no digest || - * - * The generator polynomial G(x) for this digest is given in hexadecimal - * notation (e.g. "0x3b" stands for 0011 1011, and the polynomial is - * x**5 + x**4 + x**3 + x + 1).\n - * When the initiator and target agree on a digest, this digest MUST be - * used for every PDU in the Full Feature Phase.\n - * Padding bytes, when present in a segment covered by a CRC, SHOULD be - * set to 0 and are included in the CRC.\n - * The CRC MUST be calculated by a method that produces the same results - * as the following process: - * - The PDU bits are considered as the coefficients of a polynomial - * M(x) of degree n - 1; bit 7 of the lowest numbered byte is - * considered the most significant bit (x**n - 1), followed by bit 6 - * of the lowest numbered byte through bit 0 of the highest numbered - * byte (x**0). - * - The most significant 32 bits are complemented. - * - The polynomial is multiplied by x**32, then divided by G(x). The - * generator polynomial produces a remainder R(x) of degree <= 31. - * - The coefficients of R(x) are formed into a 32-bit sequence. - * - The bit sequence is complemented, and the result is the CRC. - * - The CRC bits are mapped into the digest word. The x**31 - * coefficient is mapped to bit 7 of the lowest numbered byte of the - * digest, and the mapping continues with successive coefficients and - * bits so that the x**24 coefficient is mapped to bit 0 of the lowest - * numbered byte. The mapping continues further with the x**23 - * coefficient mapped to bit 7 of the next byte in the digest until - * the x**0 coefficient is mapped to bit 0 of the highest numbered - * byte of the digest. - * - Computing the CRC over any segment (data or header) extended to - * include the CRC built using the generator 0x11edc6f41 will always - * get the value 0x1c2d19ed as its final remainder (R(x)). This value - * is given here in its polynomial form (i.e., not mapped as the - * digest word). - * - * For a discussion about selection criteria for the CRC, see RFC3385.\n - * For a detailed analysis of the iSCSI polynomial, see Castagnoli93.\n - * Private or public extension algorithms MAY also be negotiated for - * digests. Whenever a private or public digest extension algorithm is - * part of the default offer (the offer made in the absence of explicit - * administrative action), the implementer MUST ensure that CRC32C is - * listed as an alternative in the default offer and "None" is not part - * of the default offer.\n - * Extension digest algorithms MUST be named using one of the following - * two formats: - * 1. Y-reversed.vendor.dns_name.do_something= - * 2. New public key with no name prefix constraints - * - * Digests named using the Y- format are used for private purposes - * (unregistered). New public keys must be registered with IANA using - * the IETF Review process (RFC5226). New public extensions for - * digests MUST NOT use the Y# name prefix.\n - * For private extension digests, to identify the vendor we suggest - * using the reversed DNS-name as a prefix to the proper digest names.\n - * The part of digest-name following Y- MUST conform to the format for - * standard-label specified.\n - * Support for public or private extension digests is OPTIONAL. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_HEADER_DIGEST ((const uint8_t *) "HeaderDigest\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Data digest. - * - * @verbatim - * Use: IO - * Senders: Initiator and target - * Scope: CO - * DataDigest = <list-of-values> - * Default is None for DataDigest. - * @endverbatim - * Digests enable the checking of end-to-end, non-cryptographic data - * integrity beyond the integrity checks provided by the link layers and - * the covering of the whole communication path, including all elements - * that may change the network-level PDUs, such as routers, switches, - * and proxies.\n - * The following table lists cyclic integrity checksums that can be - * negotiated for the digests and MUST be implemented by every iSCSI - * initiator and target. These digest options only have error detection - * significance. - * Name | Description | Generator - * :----- | :---------- | :---------- - * CRC32C | 32-bit CRC | 0x11EDC6F41 - * None | no digest || - * - * The generator polynomial G(x) for this digest is given in hexadecimal - * notation (e.g. "0x3b" stands for 0011 1011, and the polynomial is - * x**5 + x**4 + x**3 + x + 1).\n - * When the initiator and target agree on a digest, this digest MUST be - * used for every PDU in the Full Feature Phase.\n - * Padding bytes, when present in a segment covered by a CRC, SHOULD be - * set to 0 and are included in the CRC.\n - * The CRC MUST be calculated by a method that produces the same results - * as the following process: - * - The PDU bits are considered as the coefficients of a polynomial - * M(x) of degree n - 1; bit 7 of the lowest numbered byte is - * considered the most significant bit (x**n - 1), followed by bit 6 - * of the lowest numbered byte through bit 0 of the highest numbered - * byte (x**0). - * - The most significant 32 bits are complemented. - * - The polynomial is multiplied by x**32, then divided by G(x). The - * generator polynomial produces a remainder R(x) of degree <= 31. - * - The coefficients of R(x) are formed into a 32-bit sequence. - * - The bit sequence is complemented, and the result is the CRC. - * - The CRC bits are mapped into the digest word. The x**31 - * coefficient is mapped to bit 7 of the lowest numbered byte of the - * digest, and the mapping continues with successive coefficients and - * bits so that the x**24 coefficient is mapped to bit 0 of the lowest - * numbered byte. The mapping continues further with the x**23 - * coefficient mapped to bit 7 of the next byte in the digest until - * the x**0 coefficient is mapped to bit 0 of the highest numbered - * byte of the digest. - * - Computing the CRC over any segment (data or header) extended to - * include the CRC built using the generator 0x11edc6f41 will always - * get the value 0x1c2d19ed as its final remainder (R(x)). This value - * is given here in its polynomial form (i.e., not mapped as the - * digest word). - * - * For a discussion about selection criteria for the CRC, see RFC3385.\n - * For a detailed analysis of the iSCSI polynomial, see Castagnoli93.\n - * Private or public extension algorithms MAY also be negotiated for - * digests. Whenever a private or public digest extension algorithm is - * part of the default offer (the offer made in the absence of explicit - * administrative action), the implementer MUST ensure that CRC32C is - * listed as an alternative in the default offer and "None" is not part - * of the default offer.\n - * Extension digest algorithms MUST be named using one of the following - * two formats: - * 1. Y-reversed.vendor.dns_name.do_something= - * 2. New public key with no name prefix constraints - * - * Digests named using the Y- format are used for private purposes - * (unregistered). New public keys must be registered with IANA using - * the IETF Review process (RFC5226). New public extensions for - * digests MUST NOT use the Y# name prefix.\n - * For private extension digests, to identify the vendor we suggest - * using the reversed DNS-name as a prefix to the proper digest names.\n - * The part of digest-name following Y- MUST conform to the format for - * standard-label specified.\n - * Support for public or private extension digests is OPTIONAL. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_DIGEST ((const uint8_t *) "DataDigest\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: New connections. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * MaxConnections=<numerical-value-from-1-to-65535> - * Default is 1. - * @endverbatim - * Result function is Minimum.\n - * The initiator and target negotiate the maximum number of connections - * requested/acceptable. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_CONNECTIONS ((const uint8_t *) "MaxConnections\0") - -/** - * @brief Login/Text Operational Session Text Key: Send targets. - * - * @verbatim - * Use: FFPO - * Senders: Initiator - * Scope: SW - * @endverbatim - * The text in this appendix is a normative part of this document.\n - * To reduce the amount of configuration required on an initiator, iSCSI - * provides the SendTargets Text Request. The initiator uses the - * SendTargets request to get a list of targets to which it may have - * access, as well as the list of addresses (IP address and TCP port) on - * which these targets may be accessed.\n - * To make use of SendTargets, an initiator must first establish one of - * two types of sessions. If the initiator establishes the session - * using the key "SessionType=Discovery", the session is a Discovery - * session, and a target name does not need to be specified. Otherwise, - * the session is a Normal operational session. The SendTargets command - * MUST only be sent during the Full Feature Phase of a Normal or - * Discovery session.\n - * A system that contains targets MUST support Discovery sessions on - * each of its iSCSI IP address-port pairs and MUST support the - * SendTargets command on the Discovery session. In a Discovery - * session, a target MUST return all path information (IP address-port - * pairs and Target Portal Group Tags) for the targets on the target - * Network Entity that the requesting initiator is authorized to access.\n - * A target MUST support the SendTargets command on operational - * sessions; these will only return path information about the target to - * which the session is connected and do not need to return information - * about other target names that may be defined in the responding - * system.\n - * An initiator MAY make use of the SendTargets command as it sees fit.\n - * A SendTargets command consists of a single Text Request PDU. This - * PDU contains exactly one text key and value. The text key MUST be - * SendTargets. The expected response depends upon the value, as well - * as whether the session is a Discovery session or an operational - * session.\n - * The value must be one of: - * @verbatim - * All - * The initiator is requesting that information on all relevant - * targets known to the implementation be returned. This value - * MUST be supported on a Discovery session and MUST NOT be - * supported on an operational session. - * <iSCSI-target-name> - * If an iSCSI Target Name is specified, the session should - * respond with addresses for only the named target, if possible. - * This value MUST be supported on Discovery sessions. A - * Discovery session MUST be capable of returning addresses for - * those targets that would have been returned had value=All been - * designated. - * <nothing> - * The session should only respond with addresses for the target - * to which the session is logged in. This MUST be supported on - * operational sessions and MUST NOT return targets other than the - * one to which the session is logged in. - * @endverbatim - * The response to this command is a Text Response that contains a list - * of zero or more targets and, optionally, their addresses. Each - * target is returned as a target record. A target record begins with - * the TargetName text key, followed by a list of TargetAddress text - * keys, and bounded by the end of the Text Response or the next - * TargetName key, which begins a new record. No text keys other than - * TargetName and TargetAddress are permitted within a SendTargets - * response.\n - * A Discovery session MAY respond to a SendTargets request with its - * complete list of targets, or with a list of targets that is based on - * the name of the initiator logged in to the session.\n - * A SendTargets response MUST NOT contain target names if there are no - * targets for the requesting initiator to access.\n - * Each target record returned includes zero or more TargetAddress - * fields.\n - * Each target record starts with one text key of the form: - * @verbatim - * TargetName=<target-name-goes-here> - * @endverbatim - * followed by zero or more address keys of the form: - * @verbatim - * TargetAddress=<hostname-or-ipaddress>[:<tcp-port>], - * <portal-group-tag> - * @endverbatim - * The hostname-or-ipaddress contains a domain name, IPv4 address, or - * IPv6 address (RFC4291), as specified for the TargetAddress key.\n - * A hostname-or-ipaddress duplicated in TargetAddress responses for a - * given node (the port is absent or equal) would probably indicate that - * multiple address families are in use at once (IPv6 and IPv4).\n - * Each TargetAddress belongs to a portal group, identified by its - * numeric Target Portal Group Tag. The iSCSI Target Name, together with - * this tag, constitutes the SCSI port identifier; the tag only needs to - * be unique within a given target's name list of addresses.\n - * Multiple-connection sessions can span iSCSI addresses that belong to - * the same portal group.\n - * Multiple-connection sessions cannot span iSCSI addresses that belong - * to different portal groups.\n - * If a SendTargets response reports an iSCSI address for a target, it - * SHOULD also report all other addresses in its portal group in the - * same response.\n - * A SendTargets Text Response can be longer than a single Text Response - * PDU and makes use of the long Text Responses as specified.\n - * After obtaining a list of targets from the Discovery session, an - * iSCSI initiator may initiate new sessions to log in to the discovered - * targets for full operation. The initiator MAY keep the Discovery - * session open and MAY send subsequent SendTargets commands to discover - * new targets.\n - * Examples:\n - * This example is the SendTargets response from a single target that - * has no other interface ports.\n - * The initiator sends a Text Request that contains: - * @verbatim - * SendTargets=All - * @endverbatim - * The target sends a Text Response that contains: - * @verbatim - * TargetName=iqn.1993-11.de.uni-freiburg:diskarray.sn.8675309 - * @endverbatim - * All the target had to return in this simple case was the target name.\n - * It is assumed by the initiator that the IP address and TCP port for - * this target are the same as those used on the current connection to - * the default iSCSI target.\n - * The next example has two internal iSCSI targets, each accessible via - * two different ports with different IP addresses. The following is - * the Text Response: - * @verbatim - * TargetName=iqn.1993-11.de.uni-freiburg:diskarray.sn.8675309 - * TargetAddress=10.1.0.45:5300,1 - * TargetAddress=10.1.1.45:5300,2 - * TargetName=iqn.1993-11.de.uni-freiburg:diskarray.sn.1234567 - * TargetAddress=10.1.0.45:5300,1 - * TargetAddress=10.1.1.45:5300,2 - * @endverbatim - * Both targets share both addresses; the multiple addresses are likely - * used to provide multi-path support. The initiator may connect to - * either target name on either address. Each of the addresses has its - * own Target Portal Group Tag; they do not support spanning multiple- - * connection sessions with each other. Keep in mind that the Target - * Portal Group Tags for the two named targets are independent of one - * another; portal group "1" on the first target is not necessarily the - * same as portal group "1" on the second target.\n - * In the above example, a DNS host name or an IPv6 address could have - * been returned instead of an IPv4 address.\n - * The next Text Response shows a target that supports spanning sessions - * across multiple addresses and further illustrates the use of the - * Target Portal Group Tags: - * @verbatim - * TargetName=iqn.1993-11.de.uni-freiburg:diskarray.sn.8675309 - * TargetAddress=10.1.0.45:5300,1 - * TargetAddress=10.1.1.46:5300,1 - * TargetAddress=10.1.0.47:5300,2 - * TargetAddress=10.1.1.48:5300,2 - * TargetAddress=10.1.1.49:5300,3 - * @endverbatim - * In this example, any of the target addresses can be used to reach the - * same target. A single-connection session can be established to any - * of these TCP addresses. A multiple-connection session could span - * addresses .45 and .46 or .47 and .48 but cannot span any other - * combination. A TargetAddress with its own tag (.49) cannot be - * combined with any other address within the same session.\n - * This SendTargets response does not indicate whether .49 supports - * multiple connections per session; it is communicated via the - * MaxConnections text key upon login to the target. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_SEND_TARGETS ((const uint8_t *) "SendTargets\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Initial Ready To Transfer. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * InitialR2T=<boolean-value> - * Examples: - * I->InitialR2T=No - * T->InitialR2T=No - * Default is Yes. - * @endverbatim - * Result function is OR.\n - * The InitialR2T key is used to turn off the default use of R2T for - * unidirectional operations and the output part of bidirectional - * commands, thus allowing an initiator to start sending data to a - * target as if it has received an initial R2T with Buffer - * Offset=Immediate Data Length and Desired Data Transfer - * Length=(min(FirstBurstLength, Expected Data Transfer Length) - - * Received Immediate Data Length).\n - * The default action is that R2T is required, unless both the initiator - * and the target send this key-pair attribute specifying InitialR2T=No. - * Only the first outgoing data burst (immediate data and/or separate - * PDUs) can be sent unsolicited (i.e., not requiring an explicit R2T). - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_INITIAL_R2T ((const uint8_t *) "InitialR2T\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Immediate data. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * ImmediateData=<boolean-value> - * Default is Yes. - * @endverbatim - * Result function is AND.\n - * The initiator and target negotiate support for immediate data. To - * turn immediate data off, the initiator or target must state its - * desire to do soImmediateData can be turned on if both the - * initiator and target have ImmediateData=Yes.\n - * If ImmediateData is set to Yes and InitialR2T is set to Yes - * (default), then only immediate data are accepted in the first burst. - * If ImmediateData is set to No and InitialR2T is set to Yes, then the - * initiator MUST NOT send unsolicited data and the target MUST reject - * unsolicited data with the corresponding response code.\n - * If ImmediateData is set to No and InitialR2T is set to No, then the - * initiator MUST NOT send unsolicited immediate data but MAY send one - * unsolicited burst of Data-OUT PDUs.\n - * If ImmediateData is set to Yes and InitialR2T is set to No, then the - * initiator MAY send unsolicited immediate data and/or one unsolicited - * burst of Data-OUT PDUs.\n - * The following table is a summary of unsolicited data options: - * InitialR2T | ImmediateData | Unsolicited Data-Out PDUs | ImmediateData - * :--------- | :------------ | :------------------------ | :------------ - * | No | No | Yes | No | - * | No | Yes | Yes | Yes | - * | Yes | No | No | No | - * | Yes | Yes | No | Yes | - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IMMEDIATE_DATA ((const uint8_t *) "ImmediateData\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Maximum receive DataSegmentLength. - * - * @verbatim - * Use: ALL, Declarative - * Senders: Initiator and target - * Scope: CO - * MaxRecvDataSegmentLength=<numerical-value-512-to-(2**24 - 1)> - * Default is 8192 bytes. - * @endverbatim - * The initiator or target declares the maximum data segment length in - * bytes it can receive in an iSCSI PDU.\n - * The transmitter (initiator or target) is required to send PDUs with a - * data segment that does not exceed MaxRecvDataSegmentLength of the - * receiver.\n - * A target receiver is additionally limited by MaxBurstLength for - * solicited data and FirstBurstLength for unsolicited dataAn - * initiator MUST NOT send solicited PDUs exceeding MaxBurstLength nor - * unsolicited PDUs exceeding FirstBurstLength (or FirstBurstLength- - * Immediate Data Length if immediate data were sent). - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_RECV_DS_LEN ((const uint8_t *) "MaxRecvDataSegmentLength\0\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Maximum burst length. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * MaxBurstLength=<numerical-value-512-to-(2**24 - 1)> - * Default is 262144 (256 KB). - * @endverbatim - * Result function is Minimum.\n - * The initiator and target negotiate the maximum SCSI data payload in - * bytes in a Data-In or a solicited Data-Out iSCSI sequence. A - * sequence consists of one or more consecutive Data-In or Data-Out PDUs - * that end with a Data-In or Data-Out PDU with the F bit set to 1. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_BURST_LEN ((const uint8_t *) "MaxBurstLength\0") - -/** - * @brief Login/Text Operational Session Text Key: First burst length. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * Irrelevant when: ( InitialR2T=Yes and ImmediateData=No ) - * FirstBurstLength=<numerical-value-512-to-(2**24 - 1)> - * Default is 65536 (64 KB). - * @endverbatim - * Result function is Minimum.\n - * The initiator and target negotiate the maximum amount in bytes of - * unsolicited data an iSCSI initiator may send to the target during the - * execution of a single SCSI command. This covers the immediate data - * (if any) and the sequence of unsolicited Data-Out PDUs (if any) that - * follow the command.\n - * FirstBurstLength MUST NOT exceed MaxBurstLength. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_FIRST_BURST_LEN ((const uint8_t *) "FirstBurstLength\0\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Default time to wait. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * DefaultTime2Wait=<numerical-value-0-to-3600> - * Default is 2. - * @endverbatim - * Result function is Maximum.\n - * The initiator and target negotiate the minimum time, in seconds, to - * wait before attempting an explicit/implicit logout or an active task - * reassignment after an unexpected connection termination or a - * connection reset.\n - * A value of 0 indicates that logout or active task reassignment can be - * attempted immediately. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_WAIT ((const uint8_t *) "DefaultTime2Wait\0\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Default time to retain. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * DefaultTime2Retain=<numerical-value-0-to-3600> - * Default is 20. - * @endverbatim - * Result function is Minimum.\n - * The initiator and target negotiate the maximum time, in seconds, - * after an initial wait (Time2Wait), before which an active task - * reassignment is still possible after an unexpected connection - * termination or a connection reset.\n - * This value is also the session state timeout if the connection in - * question is the last LOGGED_IN connection in the session.\n - * A value of 0 indicates that connection/task state is immediately - * discarded by the target. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DEFAULT_TIME_RETAIN ((const uint8_t *) "DefaultTime2Retain\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Maximum outstanding Ready To Transfer. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * MaxOutstandingR2T=<numerical-value-from-1-to-65535> - * Irrelevant when: SessionType=Discovery - * Default is 1. - * @endverbatim - * Result function is Minimum.\n - * The initiator and target negotiate the maximum number of outstanding - * R2Ts per task, excluding any implied initial R2T that might be part - * of that task. An R2T is considered outstanding until the last data - * PDU (with the F bit set to 1) is transferred or a sequence reception - * timeout is encountered for that data sequence. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_MAX_OUTSTANDING_R2T ((const uint8_t *) "MaxOutstandingR2T\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Data Protocol Data Unit (PDU) in order. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * DataPDUInOrder=<boolean-value> - * Default is Yes. - * @endverbatim - * Result function is OR.\n - * "No" is used by iSCSI to indicate that the data PDUs within sequences - * can be in any order. "Yes" is used to indicate that data PDUs within - * sequences have to be at continuously increasing addresses and - * overlays are forbidden. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_PDU_IN_ORDER ((const uint8_t *) "DataPDUInOrder\0") - -/** - * @brief Login/Text Operational Session Text Key: Data sequence in order. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * DataSequenceInOrder=<boolean-value> - * Default is Yes. - * @endverbatim - * Result function is OR.\n - * A data sequence is a sequence of Data-In or Data-Out PDUs that end - * with a Data-In or Data-Out PDU with the F bit set to 1. A Data-Out - * sequence is sent either unsolicited or in response to an R2T.\n - * Sequences cover an offset-range.\n - * If DataSequenceInOrder is set to No, data PDU sequences may be - * transferred in any order.\n - * If DataSequenceInOrder is set to Yes, data sequences MUST be - * transferred using continuously non-decreasing sequence offsets (R2T - * buffer offset for writes, or the smallest SCSI Data-In buffer offset - * within a read data sequence).\n - * If DataSequenceInOrder is set to Yes, a target may retry at most the - * last R2T, and an initiator may at most request retransmission for the - * last read data sequence. For this reason, if ErrorRecoveryLevel is - * not 0 and DataSequenceInOrder is set to Yes, then MaxOutstandingR2T - * MUST be set to 1. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_DATA_SEQ_IN_ORDER ((const uint8_t *) "DataSequenceInOrder\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Error recovery level. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * ErrorRecoveryLevel=<numerical-value-0-to-2> - * Default is 0. - * @endverbatim - * Result function is Minimum.\n - * The initiator and target negotiate the recovery level supported. - * Recovery levels represent a combination of recovery capabilities. - * Each recovery level includes all the capabilities of the lower - * recovery levels and adds some new ones to them.\n - * In the description of recovery mechanisms, certain recovery classes - * are specified. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_ERR_RECOVERY_LEVEL ((const uint8_t *) "ErrorRecoveryLevel\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: X reversed vendor. - * - * @verbatim - * Use: ALL - * Senders: Initiator and target - * Scope: specific key dependent - * X-reversed.vendor.dns_name.do_something= - * @endverbatim - * Keys with this format are used for private extension purposes. These - * keys always start with X- if unregistered with IANA (private). New - * public keys (if registered with IANA via an IETF Review RFC5226) no - * longer have an X# name prefix requirement; implementers may propose - * any intuitive unique name.\n - * For unregistered keys, to identify the vendor we suggest using the - * reversed DNS-name as a prefix to the key-proper.\n - * The part of key-name following X- MUST conform to the format for - * key-name.\n - * Vendor-specific keys MUST ONLY be used in Normal sessions.\n - * Support for public or private extension keys is OPTIONAL. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_PRIV_EXT_KEY_FMT ((const uint8_t *) "X-reversed.vendor\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: Task reporting. - * - * @verbatim - * Use: LO - * Senders: Initiator and target - * Scope: SW - * Irrelevant when: SessionType=Discovery - * TaskReporting=<list-of-values> - * Default is RFC3720. - * @endverbatim - * This key is used to negotiate the task completion reporting semantics - * from the SCSI target. The following table describes the semantics - * that an iSCSI target MUST support for respective negotiated key - * values. Whenever this key is negotiated, at least the RFC3720 and - * ResponseFence values MUST be offered as options by the negotiation - * originator. - * Name | Description - * :-------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------ - * | RFC3720 | RFC 3720-compliant semantics. Response fencing is not guaranteed, and fast completion of multi-task aborting is not supported. - * | ResponseFence | Response Fence semantics MUST be supported in reporting task completions. - * | FastAbort | Updated fast multi-task abort semantics defined in MUST be supported. Support for the Response. Fence is implied - i.e., semantics MUST be supported as well. - * - * When TaskReporting is not negotiated to FastAbort, the - * standard multi-task abort semantics MUST be used. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_TASK_REPORTING ((const uint8_t *) "TaskReporting\0\0") - -/** - * @brief Login/Text Operational Session Text Key: X Node architecture. - * - * @verbatim - * Use: LO, Declarative - * Senders: Initiator and target - * Scope: SW - * X#NodeArchitecture=<list-of-values> - * Default is None. - * Examples: - * X#NodeArchitecture=ExampleOS/v1234,ExampleInc_SW_Initiator/1.05a - * X#NodeArchitecture=ExampleInc_HW_Initiator/4010,Firmware/2.0.0.5 - * X#NodeArchitecture=ExampleInc_SW_Initiator/2.1,CPU_Arch/i686 - * @endverbatim - * This document does not define the structure or content of the list of - * values.\n - * The initiator or target declares the details of its iSCSI node - * architecture to the remote endpoint. These details may include, but - * are not limited to, iSCSI vendor software, firmware, or hardware - * versions; the OS version; or hardware architecture. This key may be - * declared on a Discovery session or a Normal session.\n - * The length of the key value (total length of the list-of-values) MUST - * NOT be greater than 255 bytes.\n - * X#NodeArchitecture MUST NOT be redeclared during the Login Phase.\n - * Functional behavior of the iSCSI node (this includes the iSCSI - * protocol logic - the SCSI, iSCSI, and TCP/IP protocols) MUST NOT - * depend on the presence, absence, or content of the X#NodeArchitecture - * key. The key MUST NOT be used by iSCSI nodes for interoperability or - * for exclusion of other nodes. To ensure proper use, key values - * SHOULD be set by the node itself, and there SHOULD NOT be provisions - * for the key values to contain user-defined text.\n - * Nodes implementing this key MUST choose one of the following - * implementation options:\n - * - only transmit the key, - * - only log the key values received from other nodes, or - * - both transmit and log the key values. - * - * Each node choosing to implement transmission of the key values MUST - * be prepared to handle the response of iSCSI nodes that do not - * understand the key.\n - * Nodes that implement transmission and/or logging of the key values - * may also implement administrative mechanisms that disable and/or - * change the logging and key transmission details.\n - * Thus, a valid behavior for this key may be that a node is completely - * silent (the node does not transmit any key value and simply discards - * any key values it receives without issuing a NotUnderstood response). - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_X_NODE_ARCH ((const uint8_t *) "X#NodeArchitecture\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: IFMarker (obseleted). - * - * This document obsoletes the following keys defined in RFC3720:\n - * IFMarker, OFMarker, OFMarkInt, and IFMarkInt. However, iSCSI - * mplementations compliant to this document may still receive these - * obsoleted keys - i.e., in a responder role - in a text negotiation.\n - * When an IFMarker or OFMarker key is received, a compliant iSCSI - * implementation SHOULD respond with the constant "Reject" value. The - * implementation MAY alternatively respond with a "No" value.\n - * However, the implementation MUST NOT respond with a "NotUnderstood" - * value for either of these keys.\n - * When an IFMarkInt or OFMarkInt key is received, a compliant iSCSI - * implementation MUST respond with the constant "Reject" value. The - * implementation MUST NOT respond with a "NotUnderstood" value for - * either of these keys. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IF_MARKER ((const uint8_t *) "IFMarker\0\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: OFMarker (obseleted). - * - * This document obsoletes the following keys defined in RFC3720:\n - * IFMarker, OFMarker, OFMarkInt, and IFMarkInt. However, iSCSI - * mplementations compliant to this document may still receive these - * obsoleted keys - i.e., in a responder role - in a text negotiation.\n - * When an IFMarker or OFMarker key is received, a compliant iSCSI - * implementation SHOULD respond with the constant "Reject" value. The - * implementation MAY alternatively respond with a "No" value.\n - * However, the implementation MUST NOT respond with a "NotUnderstood" - * value for either of these keys.\n - * When an IFMarkInt or OFMarkInt key is received, a compliant iSCSI - * implementation MUST respond with the constant "Reject" value. The - * implementation MUST NOT respond with a "NotUnderstood" value for - * either of these keys. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_OF_MARKER ((const uint8_t *) "OFMarker\0\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: OFMarkInt (obseleted). - * - * This document obsoletes the following keys defined in RFC3720:\n - * IFMarker, OFMarker, OFMarkInt, and IFMarkInt. However, iSCSI - * mplementations compliant to this document may still receive these - * obsoleted keys - i.e., in a responder role - in a text negotiation.\n - * When an IFMarker or OFMarker key is received, a compliant iSCSI - * implementation SHOULD respond with the constant "Reject" value. The - * implementation MAY alternatively respond with a "No" value.\n - * However, the implementation MUST NOT respond with a "NotUnderstood" - * value for either of these keys.\n - * When an IFMarkInt or OFMarkInt key is received, a compliant iSCSI - * implementation MUST respond with the constant "Reject" value. The - * implementation MUST NOT respond with a "NotUnderstood" value for - * either of these keys. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_OF_MARK_INT ((const uint8_t *) "OFMarkInt\0\0\0\0\0\0") - -/** - * @brief Login/Text Operational Session Text Key: IFMarkInt (obseleted). - * - * This document obsoletes the following keys defined in RFC3720:\n - * IFMarker, OFMarker, OFMarkInt, and IFMarkInt. However, iSCSI - * mplementations compliant to this document may still receive these - * obsoleted keys - i.e., in a responder role - in a text negotiation.\n - * When an IFMarker or OFMarker key is received, a compliant iSCSI - * implementation SHOULD respond with the constant "Reject" value. The - * implementation MAY alternatively respond with a "No" value.\n - * However, the implementation MUST NOT respond with a "NotUnderstood" - * value for either of these keys.\n - * When an IFMarkInt or OFMarkInt key is received, a compliant iSCSI - * implementation MUST respond with the constant "Reject" value. The - * implementation MUST NOT respond with a "NotUnderstood" value for - * either of these keys. - */ -#define ISCSI_LOGIN_AUTH_SESSION_TEXT_KEY_IF_MARK_INT ((const uint8_t *) "IFMarkInt\0\0\0\0\0\0") - - /// Login request Next Stage (NSG) flags: SecurityNegotiation. #define ISCSI_LOGIN_REQ_FLAGS_NEXT_STAGE_SECURITY_NEGOTIATION 0x0 @@ -8436,119 +4355,119 @@ typedef struct __attribute__((packed)) iscsi_isid { * Login Requests are always considered as immediate. */ typedef struct __attribute__((packed)) iscsi_login_req_packet { - /// Always 0x03 according to iSCSI specification. - uint8_t opcode; - - /// Login request flags. - int8_t flags; - - /** - * @brief Version-max indicates the maximum version number supported. - * - * All Login Requests within the Login Phase MUST carry the same - * Version-max. Currently, this is always 0.\n - * The target MUST use the value presented with the first Login Request. - */ - uint8_t version_max; - - /** - * @brief Version-min indicates the minimum version number supported. - * - * All Login Requests within the Login Phase MUST carry the same - * Version-min. The target MUST use the value presented with the first - * Login Request. Always 0 for now. - */ - uint8_t version_min; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// Initiator Session ID (ISID). - iscsi_isid isid; - - /** - * @brief Target Session Identifying Handle (TSIH). - * - * The TSIH must be set in the first Login Request. The reserved value - * 0 MUST be used on the first connection for a new session. Otherwise, - * the TSIH sent by the target at the conclusion of the successful login - * of the first connection for this session MUST be used. The TSIH - * identifies to the target the associated existing session for this new - * connection.\n - * All Login Requests within a Login Phase MUST carry the same TSIH. - * The target MUST check the value presented with the first Login - * Request. - */ - uint16_t tsih; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /** - * @brief Connection ID (CID). - * - * The CID provides a unique ID for this connection within the session.\n - * All Login Requests within the Login Phase MUST carry the same CID. - * The target MUST use the value presented with the first Login Request.\n - * A Login Request with a non-zero TSIH and a CID equal to that of an - * existing connection implies a logout of the connection followed by a - * login. - */ - uint16_t cid; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /** - * @brief CmdSN. - * - * The CmdSN is either the initial command sequence number of a session - * (for the first Login Request of a session - the "leading" login) or - * the command sequence number in the command stream if the login is for - * a new connection in an existing session.\n - * Examples: - * - Login on a leading connection: If the leading login carries the - * CmdSN 123, all other Login Requests in the same Login Phase carry - * the CmdSN 123, and the first non-immediate command in the Full - * Feature Phase also carries the CmdSN 123. - * - Login on other than a leading connection: If the current CmdSN at - * the time the first login on the connection is issued is 500, then - * that PDU carries CmdSN=500. Subsequent Login Requests that are - * needed to complete this Login Phase may carry a CmdSN higher than - * 500 if non-immediate requests that were issued on other connections - * in the same session advance the CmdSN. - * - * If the Login Request is a leading Login Request, the target MUST use - * the value presented in the CmdSN as the target value for the - * ExpCmdSN. - */ - uint32_t cmd_sn; - - /** - * @brief ExpStatSN. - * - * For the first Login Request on a connection, this is the ExpStatSN - * for the old connection, and this field is only valid if the Login - * Request restarts a connection.\n - * For subsequent Login Requests, it is used to acknowledge the Login - * Responses with their increasing StatSN values. - */ - uint32_t exp_stat_sn; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2[2]; - - /** - * @brief Data segment - Login Parameters in Text Request Format. - * - * The initiator MUST provide some basic parameters in order - * to enable the target to determine if the initiator may use - * the target's resources and the initial text parameters for the security exchange - */ - iscsi_scsi_ds_cmd_data ds_cmd_data; + /// Always 0x03 according to iSCSI specification. + uint8_t opcode; + + /// Login request flags. + int8_t flags; + + /** + * @brief Version-max indicates the maximum version number supported. + * + * All Login Requests within the Login Phase MUST carry the same + * Version-max. Currently, this is always 0.\n + * The target MUST use the value presented with the first Login Request. + */ + uint8_t version_max; + + /** + * @brief Version-min indicates the minimum version number supported. + * + * All Login Requests within the Login Phase MUST carry the same + * Version-min. The target MUST use the value presented with the first + * Login Request. Always 0 for now. + */ + uint8_t version_min; + + /// TotalAHSLength. + uint8_t total_ahs_len; + + /// DataSegmentLength. + uint8_t ds_len[3]; + + /// Initiator Session ID (ISID). + iscsi_isid isid; + + /** + * @brief Target Session Identifying Handle (TSIH). + * + * The TSIH must be set in the first Login Request. The reserved value + * 0 MUST be used on the first connection for a new session. Otherwise, + * the TSIH sent by the target at the conclusion of the successful login + * of the first connection for this session MUST be used. The TSIH + * identifies to the target the associated existing session for this new + * connection.\n + * All Login Requests within a Login Phase MUST carry the same TSIH. + * The target MUST check the value presented with the first Login + * Request. + */ + uint16_t tsih; + + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; + + /** + * @brief Connection ID (CID). + * + * The CID provides a unique ID for this connection within the session.\n + * All Login Requests within the Login Phase MUST carry the same CID. + * The target MUST use the value presented with the first Login Request.\n + * A Login Request with a non-zero TSIH and a CID equal to that of an + * existing connection implies a logout of the connection followed by a + * login. + */ + uint16_t cid; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved; + + /** + * @brief CmdSN. + * + * The CmdSN is either the initial command sequence number of a session + * (for the first Login Request of a session - the "leading" login) or + * the command sequence number in the command stream if the login is for + * a new connection in an existing session.\n + * Examples: + * - Login on a leading connection: If the leading login carries the + * CmdSN 123, all other Login Requests in the same Login Phase carry + * the CmdSN 123, and the first non-immediate command in the Full + * Feature Phase also carries the CmdSN 123. + * - Login on other than a leading connection: If the current CmdSN at + * the time the first login on the connection is issued is 500, then + * that PDU carries CmdSN=500. Subsequent Login Requests that are + * needed to complete this Login Phase may carry a CmdSN higher than + * 500 if non-immediate requests that were issued on other connections + * in the same session advance the CmdSN. + * + * If the Login Request is a leading Login Request, the target MUST use + * the value presented in the CmdSN as the target value for the + * ExpCmdSN. + */ + uint32_t cmd_sn; + + /** + * @brief ExpStatSN. + * + * For the first Login Request on a connection, this is the ExpStatSN + * for the old connection, and this field is only valid if the Login + * Request restarts a connection.\n + * For subsequent Login Requests, it is used to acknowledge the Login + * Responses with their increasing StatSN values. + */ + uint32_t exp_stat_sn; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved2[2]; + + /** + * @brief Data segment - Login Parameters in Text Request Format. + * + * The initiator MUST provide some basic parameters in order + * to enable the target to determine if the initiator may use + * the target's resources and the initial text parameters for the security exchange + */ + iscsi_scsi_ds_cmd_data ds_cmd_data; } iscsi_login_req_packet; @@ -8795,107 +4714,107 @@ typedef struct __attribute__((packed)) iscsi_login_req_packet { * Phase. */ typedef struct __attribute__((packed)) iscsi_login_response_packet { - /// Always 0x23 according to iSCSI specification. - uint8_t opcode; - - /// Login response flags. - int8_t flags; - - /** - * @brief This is the highest version number supported by the target. - * - * All Login Responses within the Login Phase MUST carry the same - * Version-max. - */ - uint8_t version_max; - - /** - * @brief Version-active indicates the highest version supported by the target and initiator. - * - * If the target does not support a version within the - * range specified by the initiator, the target rejects the login and - * this field indicates the lowest version supported by the target. - * All Login Responses within the Login Phase MUST carry the same - * Version-active.\n - * The initiator MUST use the value presented as a response to the first - * Login Request. - */ - uint8_t version_active; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// Initiator Session ID (ISID). - iscsi_isid isid; - - /** - * @brief Target Session Identifying Handle (TSIH). - * - * The TSIH is the target-assigned session-identifying handle. Its - * internal format and content are not defined by this protocol, except - * for the value 0, which is reserved. With the exception of the Login - * Final-Response in a new session, this field should be set to the TSIH - * provided by the initiator in the Login Request. For a new session, - * the target MUST generate a non-zero TSIH and ONLY return it in the - * Login Final-Response. - */ - uint16_t tsih; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved; - - /** - * @brief StatSN. - * - * For the first Login Response (the response to the first Login - * Request), this is the starting status sequence number for the - * connection. The next response of any kind - including the next - * Login Response, if any, in the same Login Phase - will carry this - * number + 1. This field is only valid if the Status-Class is 0. - */ - uint32_t stat_sn; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /** - * @brief Status-class. - * - * Status-class (see above for details). If the Status-Class is - * not 0, the initiator and target MUST close the TCP connection - * If the target wishes to reject the Login Request for more than one - * reason, it should return the primary reason for the rejection. - */ - uint8_t status_class; - - /// Status-detail. - uint8_t status_detail; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved2; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved3; - - /** - * @brief Data segment - Login Parameters in Text Request Format. - * - * The target MUST provide some basic parameters in order to enable the - * initiator to determine if it is connected to the correct port and the - * initial text parameters for the security exchange.\n - * All the rules specified for Text Responses also hold for Login - * Responses. - */ - iscsi_scsi_ds_cmd_data ds_cmd_data; + /// Always 0x23 according to iSCSI specification. + uint8_t opcode; + + /// Login response flags. + int8_t flags; + + /** + * @brief This is the highest version number supported by the target. + * + * All Login Responses within the Login Phase MUST carry the same + * Version-max. + */ + uint8_t version_max; + + /** + * @brief Version-active indicates the highest version supported by the target and initiator. + * + * If the target does not support a version within the + * range specified by the initiator, the target rejects the login and + * this field indicates the lowest version supported by the target. + * All Login Responses within the Login Phase MUST carry the same + * Version-active.\n + * The initiator MUST use the value presented as a response to the first + * Login Request. + */ + uint8_t version_active; + + /// TotalAHSLength. + uint8_t total_ahs_len; + + /// DataSegmentLength. + uint8_t ds_len[3]; + + /// Initiator Session ID (ISID). + iscsi_isid isid; + + /** + * @brief Target Session Identifying Handle (TSIH). + * + * The TSIH is the target-assigned session-identifying handle. Its + * internal format and content are not defined by this protocol, except + * for the value 0, which is reserved. With the exception of the Login + * Final-Response in a new session, this field should be set to the TSIH + * provided by the initiator in the Login Request. For a new session, + * the target MUST generate a non-zero TSIH and ONLY return it in the + * Login Final-Response. + */ + uint16_t tsih; + + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; + + /// Reserved for future usage, always MUST be 0. + uint32_t reserved; + + /** + * @brief StatSN. + * + * For the first Login Response (the response to the first Login + * Request), this is the starting status sequence number for the + * connection. The next response of any kind - including the next + * Login Response, if any, in the same Login Phase - will carry this + * number + 1. This field is only valid if the Status-Class is 0. + */ + uint32_t stat_sn; + + /// ExpCmdSN. + uint32_t exp_cmd_sn; + + /// MaxCmdSN. + uint32_t max_cmd_sn; + + /** + * @brief Status-class. + * + * Status-class (see above for details). If the Status-Class is + * not 0, the initiator and target MUST close the TCP connection + * If the target wishes to reject the Login Request for more than one + * reason, it should return the primary reason for the rejection. + */ + uint8_t status_class; + + /// Status-detail. + uint8_t status_detail; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved2; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved3; + + /** + * @brief Data segment - Login Parameters in Text Request Format. + * + * The target MUST provide some basic parameters in order to enable the + * initiator to determine if it is connected to the correct port and the + * initial text parameters for the security exchange.\n + * All the rules specified for Text Responses also hold for Login + * Responses. + */ + iscsi_scsi_ds_cmd_data ds_cmd_data; } iscsi_login_response_packet; @@ -9003,82 +4922,79 @@ typedef struct __attribute__((packed)) iscsi_login_response_packet { * recovery, unless the session is also closed. */ typedef struct __attribute__((packed)) iscsi_logout_req_packet { - /// Always 6 according to iSCSI specification. - uint8_t opcode; - - /** - * @brief Reason code. - * - * A target implicitly terminates the active tasks due to the iSCSI - * protocol in the following cases: - * -# When a connection is implicitly or explicitly logged out with - * the reason code "close the connection" and there are active - * tasks allegiant to that connection. - * -# When a connection fails and eventually the connection state - * times out and there are active tasks allegiant to that - * connection - * -# When a successful recovery Logout is performed while there are - * active tasks allegiant to that connection and those tasks - * eventually time out after the Time2Wait and Time2Retain periods - * without allegiance reassignment - * -# When a connection is implicitly or explicitly logged out with - * the reason code "close the session" and there are active tasks - * in that session - * - * If the tasks terminated in any of the above cases are SCSI tasks, - * they must be internally terminated as if with CHECK CONDITION status. - * This status is only meaningful for appropriately handling the - * internal SCSI state and SCSI side effects with respect to ordering, - * because this status is never communicated back as a terminating - * status to the initiator. However, additional actions may have to be - * taken at the SCSI level, depending on the SCSI context as defined by - * the SCSI standards (e.g., queued commands and ACA; UA for the next - * command on the I_T nexus in cases a), b), and c) above). After the - * tasks are terminated, the target MUST report a Unit Attention condition - * on the next command processed on any connection for each affected - * I_T_L nexus with the status of CHECK CONDITION, the ASC/ASCQ value - * of 0x47 / 0x7F ("SOME COMMANDS CLEARED BY ISCSI PROTOCOL EVENT"), etc. - */ - int8_t reason_code; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength (MUST be 0 for this PDU). - uint8_t total_ahs_len; - - /// DataSegmentLength (MUST be 0 for this PDU). - uint8_t ds_len[3]; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /** - * @brief Connection ID (CID). - * - * This is the connection ID of the connection to be closed (including - * closing the TCP stream). This field is only valid if the reason code - * is not "close the session". - */ - uint16_t cid; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved3; - - /// CmdSN. - uint32_t cmd_sn; - - /// This is the last ExpStatSN value for the connection to be closed. - uint32_t exp_stat_sn; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved4[2]; - - /// Optional header digest. - iscsi_header_digest hdr_digest; + /// Always 6 according to iSCSI specification. + uint8_t opcode; + + /** + * @brief Reason code. + * + * A target implicitly terminates the active tasks due to the iSCSI + * protocol in the following cases: + * -# When a connection is implicitly or explicitly logged out with + * the reason code "close the connection" and there are active + * tasks allegiant to that connection. + * -# When a connection fails and eventually the connection state + * times out and there are active tasks allegiant to that + * connection + * -# When a successful recovery Logout is performed while there are + * active tasks allegiant to that connection and those tasks + * eventually time out after the Time2Wait and Time2Retain periods + * without allegiance reassignment + * -# When a connection is implicitly or explicitly logged out with + * the reason code "close the session" and there are active tasks + * in that session + * + * If the tasks terminated in any of the above cases are SCSI tasks, + * they must be internally terminated as if with CHECK CONDITION status. + * This status is only meaningful for appropriately handling the + * internal SCSI state and SCSI side effects with respect to ordering, + * because this status is never communicated back as a terminating + * status to the initiator. However, additional actions may have to be + * taken at the SCSI level, depending on the SCSI context as defined by + * the SCSI standards (e.g., queued commands and ACA; UA for the next + * command on the I_T nexus in cases a), b), and c) above). After the + * tasks are terminated, the target MUST report a Unit Attention condition + * on the next command processed on any connection for each affected + * I_T_L nexus with the status of CHECK CONDITION, the ASC/ASCQ value + * of 0x47 / 0x7F ("SOME COMMANDS CLEARED BY ISCSI PROTOCOL EVENT"), etc. + */ + int8_t reason_code; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved; + + /// TotalAHSLength (MUST be 0 for this PDU). + uint8_t total_ahs_len; + + /// DataSegmentLength (MUST be 0 for this PDU). + uint8_t ds_len[3]; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved2; + + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; + + /** + * @brief Connection ID (CID). + * + * This is the connection ID of the connection to be closed (including + * closing the TCP stream). This field is only valid if the reason code + * is not "close the session". + */ + uint16_t cid; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved3; + + /// CmdSN. + uint32_t cmd_sn; + + /// This is the last ExpStatSN value for the connection to be closed. + uint32_t exp_stat_sn; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved4[2]; } iscsi_logout_req_packet; @@ -9105,272 +5021,90 @@ typedef struct __attribute__((packed)) iscsi_logout_req_packet { * was session close). */ typedef struct __attribute__((packed)) iscsi_logout_response_packet { - /// Always 0x26 according to iSCSI specification. - uint8_t opcode; - - /// Reserved for future usage (always MUST be 0x80 for now). - int8_t flags; - - /// Response. - uint8_t response; - - /// Reserved for future usage, always MUST be 0. - uint8_t reserved; - - /// TotalAHSLength (MUST be 0 for this PDU). - uint8_t total_ahs_len; - - /// DataSegmentLength (MUST be 0 for this PDU). - uint8_t ds_len[3]; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved3; - - /// StatSN. - uint32_t stat_sn; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved4; - - /** - * @brief Time2Wait. - * - * If the Logout response code is 0 and the operational - * ErrorRecoveryLevel is 2, this is the minimum amount of time, in - * seconds, to wait before attempting task reassignment. If the Logout - * response code is 0 and the operational ErrorRecoveryLevel is less - * than 2, this field is to be ignored.\n - * This field is invalid if the Logout response code is 1.\n - * If the Logout response code is 2 or 3, this field specifies the - * minimum time to wait before attempting a new implicit or explicit - * logout.\n - * If Time2Wait is 0, the reassignment or a new Logout may be attempted - * immediately. - */ - uint16_t time_wait; - - /** - * @brief Time2Retain. - * - * If the Logout response code is 0 and the operational - * ErrorRecoveryLevel is 2, this is the maximum amount of time, in - * seconds, after the initial wait (Time2Wait) that the target waits for - * the allegiance reassignment for any active task, after which the task - * state is discarded. If the Logout response code is 0 and the - * operational ErrorRecoveryLevel is less than 2, this field is to be - * ignored.\n - * This field is invalid if the Logout response code is 1.\n - * If the Logout response code is 2 or 3, this field specifies the - * maximum amount of time, in seconds, after the initial wait - * (Time2Wait) that the target waits for a new implicit or explicit - * logout.\n - * If it is the last connection of a session, the whole session state is - * discarded after Time2Retain.\n - * If Time2Retain is 0, the target has already discarded the connection - * (and possibly the session) state along with the task states. No - * reassignment or Logout is required in this case. - */ - uint16_t time_retain; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved5; - - /// Optional header digest. - iscsi_header_digest hdr_digest; + /// Always 0x26 according to iSCSI specification. + uint8_t opcode; + + /// Reserved for future usage (must be always 0x80 for now). + int8_t flags; + + /// Response. + uint8_t response; + + /// Reserved for future usage, always MUST be 0. + uint8_t reserved; + + /// TotalAHSLength (MUST be 0 for this PDU). + uint8_t total_ahs_len; + + /// DataSegmentLength (MUST be 0 for this PDU). + uint8_t ds_len[3]; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved2; + + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; + + /// Reserved for future usage, always MUST be 0. + uint32_t reserved3; + + /// StatSN. + uint32_t stat_sn; + + /// ExpCmdSN. + uint32_t exp_cmd_sn; + + /// MaxCmdSN. + uint32_t max_cmd_sn; + + /// Reserved for future usage, always MUST be 0. + uint32_t reserved4; + + /** + * @brief Time2Wait. + * + * If the Logout response code is 0 and the operational + * ErrorRecoveryLevel is 2, this is the minimum amount of time, in + * seconds, to wait before attempting task reassignment. If the Logout + * response code is 0 and the operational ErrorRecoveryLevel is less + * than 2, this field is to be ignored.\n + * This field is invalid if the Logout response code is 1.\n + * If the Logout response code is 2 or 3, this field specifies the + * minimum time to wait before attempting a new implicit or explicit + * logout.\n + * If Time2Wait is 0, the reassignment or a new Logout may be attempted + * immediately. + */ + uint16_t time_wait; + + /** + * @brief Time2Retain. + * + * If the Logout response code is 0 and the operational + * ErrorRecoveryLevel is 2, this is the maximum amount of time, in + * seconds, after the initial wait (Time2Wait) that the target waits for + * the allegiance reassignment for any active task, after which the task + * state is discarded. If the Logout response code is 0 and the + * operational ErrorRecoveryLevel is less than 2, this field is to be + * ignored.\n + * This field is invalid if the Logout response code is 1.\n + * If the Logout response code is 2 or 3, this field specifies the + * maximum amount of time, in seconds, after the initial wait + * (Time2Wait) that the target waits for a new implicit or explicit + * logout.\n + * If it is the last connection of a session, the whole session state is + * discarded after Time2Retain.\n + * If Time2Retain is 0, the target has already discarded the connection + * (and possibly the session) state along with the task states. No + * reassignment or Logout is required in this case. + */ + uint16_t time_retain; + + /// Reserved for future usage, always MUST be 0. + uint32_t reserved5; } iscsi_logout_response_packet; -/// Selective Negative / Sequence Number Acknowledgment (SNACK) request: Data/R2T SNACK: requesting retransmission of one or more Data-In or R2T PDUs. -#define ISCSI_SNACK_REQ_TYPE_DATA_R2T_SNACK 0x00 - -/// Selective Negative / Sequence Number Acknowledgment (SNACK) request: -#define ISCSI_SNACK_REQ_TYPE_STATUS_SNACK 0x01 // Status SNACK: requesting retransmission of one or more - // numbered responses - -/** - * @brief Selective Negative / Sequence Number Acknowledgment (SNACK) request: DataACK: positively acknowledges Data-In PDUs. - * - * If an initiator operates at ErrorRecoveryLevel 1 or higher, it MUST - * issue a SNACK of type DataACK after receiving a Data-In PDU with the - * A bit set to 1. However, if the initiator has detected holes in the - * input sequence, it MUST postpone issuing the SNACK of type DataACK - * until the holes are filled. An initiator MAY ignore the A bit if it - * deems that the bit is being set aggressively by the target (i.e., - * before the MaxBurstLength limit is reached).\n - * The DataACK is used to free resources at the target and not to - * request or imply data retransmission.\n - * An initiator MUST NOT request retransmission for any data it had - * already acknowledged - */ -#define ISCSI_SNACK_REQ_TYPE_DATA_ACK 0x02 - -/** - * @brief Selective Negative / Sequence Number Acknowledgment (SNACK) request: R-Data SNACK: requesting retransmission of Data-In PDUs with possible resegmentation and status tagging. - * - * If the initiator MaxRecvDataSegmentLength changed between the - * original transmission and the time the initiator requests - * retransmission, the initiator MUST issue a R-Data SNACK.\n - * With R-Data SNACK, the initiator indicates that it discards all the - * unacknowledged data and expects the target to resend it. It also - * expects resegmentation. In this case, the retransmitted Data-In PDUs - * MAY be different from the ones originally sent in order to reflect - * changes in MaxRecvDataSegmentLength. Their DataSN starts with the - * BegRun of the last DataACK received by the target if any was received; - * otherwise, it starts with 0 and is increased by 1 for each resent - * Data-In PDU.\n - * A target that has received a R-Data SNACK MUST return a SCSI Response - * that contains a copy of the SNACK Tag field from the R-Data SNACK in - * the SCSI Response SNACK Tag field as its last or only Response. For - * example, if it has already sent a response containing another value - * in the SNACK Tag field or had the status included in the last Data-In - * PDU, it must send a new SCSI Response PDU. If a target sends more - * than one SCSI Response PDU due to this rule, all SCSI Response PDUs - * must carry the same StatSN. If an initiator attempts to recover a lost - * SCSI Response when more than one response has been sent, the - * target will send the SCSI Response with the latest content known to - * the target, including the last SNACK Tag for the command.\n - * For considerations in allegiance reassignment of a task to a - * connection with a different MaxRecvDataSegmentLength. - */ -#define ISCSI_SNACK_REQ_TYPE_R_DATA_SNACK 0x03 - - -/** - * @brief iSCSI SNACK Request packet data. - * - * If the implementation supports ErrorRecoveryLevel greater than zero, - * it MUST support all SNACK types. - * - * The SNACK is used by the initiator to request the retransmission of - * numbered responses, data, or R2T PDUs from the target. The SNACK - * Request indicates the numbered responses or data "runs" whose - * retransmission is requested, where the run starts with the first - * StatSN, DataSN, or R2TSN whose retransmission is requested and - * indicates the number of Status, Data, or R2T PDUs requested, - * including the first. 0 has special meaning when used as a starting - * number and length: - * - * - When used in RunLength, it means all PDUs starting with the - * initial. - * - * - When used in both BegRun and RunLength, it means all - * unacknowledged PDUs. - * - * The numbered response(s) or R2T(s) requested by a SNACK MUST be - * delivered as exact replicas of the ones that the target transmitted - * originally, except for the fields ExpCmdSN, MaxCmdSN, and ExpDataSN, - * which MUST carry the current values. R2T(s)requested by SNACK MUST - * also carry the current value of the StatSN. - * - * The numbered Data-In PDUs requested by a Data SNACK MUST be delivered - * as exact replicas of the ones that the target transmitted originally, - * except for the fields ExpCmdSN and MaxCmdSN, which MUST carry the - * current values; and except for resegmentation. - * - * Any SNACK that requests a numbered response, data, or R2T that was - * not sent by the target or was already acknowledged by the initiator - * MUST be rejected with a reason code of "Protocol Error". - */ -typedef struct __attribute__((packed)) iscsi_snack_req_packet { - /// Always 0x10 according to iSCSI specification. - uint8_t opcode; - - /** - * @brief Type. - * - * Data/R2T SNACK, Status SNACK, or R-Data SNACK for a command MUST - * precede status acknowledgment for the given command. - */ - int8_t type; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// LUN or Reserved. - uint64_t lun; - - /** - * @brief Initiator Task Tag (ITT). - * - * For a Status SNACK and DataACK, the Initiator Task Tag MUST be set to - * the reserved value 0xFFFFFFFF. In all other cases, the Initiator - * Task Tag field MUST be set to the Initiator Task Tag of the - * referenced command. - */ - uint32_t init_task_tag; - - /** - * @brief Target Transfer Tag (TTT). - * - * For a R-Data SNACK, this field MUST contain a value that is different - * from 0 or 0xFFFFFFFF and is unique for the task (identified by the - * Initiator Task Tag). This value MUST be copied by the iSCSI target - * in the last or only SCSI Response PDU it issues for the command.\n - * For DataACK, the Target Transfer Tag MUST contain a copy of the - * Target Transfer Tag and LUN provided with the SCSI Data-In PDU with - * the A bit set to 1.\n - * In all other cases, the Target Transfer Tag field MUST be set to the - * reserved value 0xFFFFFFFF. - */ - uint32_t target_xfer_snack_tag; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved2; - - /// ExpStatSN. - uint32_t exp_stat_sn; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved3; - - /** - * @brief BegRun. - * - * This field indicates the DataSN, R2TSN, or StatSN of the first PDU - * whose retransmission is requested (Data/R2T and Status SNACK), or the - * next expected DataSN (DataACK SNACK).\n - * A BegRun of 0, when used in conjunction with a RunLength of 0, means - * "resend all unacknowledged Data-In, R2T or Response PDUs". - * BegRun MUST be 0 for a R-Data SNACK. - */ - uint32_t beg_run; - - /** - * @brief RunLength. - * - * This field indicates the number of PDUs whose retransmission is - * requested.\n - * A RunLength of 0 signals that all Data-In, R2T, or Response PDUs - * carrying the numbers equal to or greater than BegRun have to be - * resent.\n - * The RunLength MUST also be 0 for a DataACK SNACK in addition to a - * R-Data SNACK. - */ - uint32_t run_len; - - /// Optional header digest. - iscsi_header_digest hdr_digest; -} iscsi_snack_req_packet; - - /// iSCSI Reject packet data: Reserved, original PDU can't be resent. #define ISCSI_REJECT_REASON_RESERVED 0x01 @@ -9437,100 +5171,91 @@ typedef struct __attribute__((packed)) iscsi_snack_req_packet { * packet was rejected or has been rejected for some reason. */ typedef struct __attribute__((packed)) iscsi_reject_packet { - /// Always 0x3F according to iSCSI specification. - uint8_t opcode; - - /// Reserved for future usage (always MUST be 0x80 for now). - int8_t flags; - - /** - * @brief Reject reason. - * - * In all the cases in which a pre-instantiated SCSI task is terminated - * because of the reject, the target MUST issue a proper SCSI command - * response with CHECK CONDITION. In these cases in which a status for - * the SCSI task was already sent before the reject, no additional - * status is required. If the error is detected while data from the - * initiator is still expected (i.e., the command PDU did not contain - * all the data and the target has not received a Data-Out PDU with the - * Final bit set to 1 for the unsolicited data, if any, and all - * outstanding R2Ts, if any), the target MUST wait until it receives - * the last expected Data-Out PDUs with the F bit set to 1 before - * sending the Response PDU. - */ - uint8_t reason; - - /// Reserved for future usage, always MUST be 0. - uint8_t reserved; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2; - - /// Always 0xFFFFFFFF for now. - uint32_t tag; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved3; - - /** - * @brief StatSN. - * - * This field carries its usual value and is not related to the - * rejected command. The StatSN is advanced after a Reject. - */ - uint32_t stat_sn; - - /** - * @brief ExpCmdSN. - * - * This field carries its usual value and is not related to the - * rejected command. - */ - uint32_t exp_cmd_sn; - - /** - * @brief MaxCmdSN. - * - * This field carries its usual value and is not related to the - * rejected command. - */ - uint32_t max_cmd_sn; - - /** - * @brief DataSN / Ready To Transfer Sequence Number (R2TSN) or Reserved. - * - * This field is only valid if the rejected PDU is a Data/R2T SNACK and - * the Reject reason code is "Protocol Error". The DataSN/R2TSN is the - * next Data/R2T sequence number that the target would send for the - * task, if any. - */ - uint32_t data_r2t_sn; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved4; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /** - * @brief Complete Header of Bad PDU. - * - * The target returns the header (not including the digest) of the - * PDU in error as the data of the response. - */ - iscsi_bhs_packet bad_pdu_hdr; - - /// Vendor-specific data (if any). - uint8_t vendor_data[0]; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 0x3F according to iSCSI specification. + uint8_t opcode; + + /// Reserved for future usage (must be always 0x80 for now). + int8_t flags; + + /** + * @brief Reject reason. + * + * In all the cases in which a pre-instantiated SCSI task is terminated + * because of the reject, the target MUST issue a proper SCSI command + * response with CHECK CONDITION. In these cases in which a status for + * the SCSI task was already sent before the reject, no additional + * status is required. If the error is detected while data from the + * initiator is still expected (i.e., the command PDU did not contain + * all the data and the target has not received a Data-Out PDU with the + * Final bit set to 1 for the unsolicited data, if any, and all + * outstanding R2Ts, if any), the target MUST wait until it receives + * the last expected Data-Out PDUs with the F bit set to 1 before + * sending the Response PDU. + */ + uint8_t reason; + + /// Reserved for future usage, always MUST be 0. + uint8_t reserved; + + /// TotalAHSLength. + uint8_t total_ahs_len; + + /// DataSegmentLength. + uint8_t ds_len[3]; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved2; + + /// Always 0xFFFFFFFF for now. + uint32_t tag; + + /// Reserved for future usage, always MUST be 0. + uint32_t reserved3; + + /** + * @brief StatSN. + * + * This field carries its usual value and is not related to the + * rejected command. The StatSN is advanced after a Reject. + */ + uint32_t stat_sn; + + /** + * @brief ExpCmdSN. + * + * This field carries its usual value and is not related to the + * rejected command. + */ + uint32_t exp_cmd_sn; + + /** + * @brief MaxCmdSN. + * + * This field carries its usual value and is not related to the + * rejected command. + */ + uint32_t max_cmd_sn; + + /** + * @brief DataSN / Ready To Transfer Sequence Number (R2TSN) or Reserved. + * + * This field is only valid if the rejected PDU is a Data/R2T SNACK and + * the Reject reason code is "Protocol Error". The DataSN/R2TSN is the + * next Data/R2T sequence number that the target would send for the + * task, if any. + */ + uint32_t data_r2t_sn; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved4; + + /** + * @brief Complete Header of Bad PDU. + * + * The target returns the header (not including the digest) of the + * PDU in error as the data of the response. + */ + iscsi_bhs_packet bad_pdu_hdr; } iscsi_reject_packet; /** @@ -9555,76 +5280,76 @@ typedef struct __attribute__((packed)) iscsi_reject_packet { * in response to each other. */ typedef struct __attribute__((packed)) iscsi_nop_out_packet { - /// Always 0x00 according to iSCSI specification. - uint8_t opcode; - - /// Reserved for future usage (always MUST be 0x80 for now). - int8_t flags; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength. - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// LUN or Reserved. - uint64_t lun; - - /** - * @brief Initiator Task Tag (ITT). - * - * The NOP-Out MUST have the Initiator Task Tag set to a valid value - * only if a response in the form of a NOP-In is requested (i.e., the - * NOP-Out is used as a ping request). Otherwise, the Initiator Task - * Tag MUST be set to 0xFFFFFFFF.\n - * When a target receives the NOP-Out with a valid Initiator Task Tag, - * it MUST respond with a NOP-In Response.\n - * If the Initiator Task Tag contains 0xFFFFFFFF, the I bit MUST be set - * to 1, and the CmdSN is not advanced after this PDU is sent. - */ - uint32_t init_task_tag; - - /** - * @brief Target Transfer Tag (TTT). - * - * The Target Transfer Tag is a target-assigned identifier for the - * operation.\n - * The NOP-Out MUST only have the Target Transfer Tag set if it is - * issued in response to a NOP-In with a valid Target Transfer Tag. In - * this case, it copies the Target Transfer Tag from the NOP-In PDU.\n - * Otherwise, the Target Transfer Tag MUST be set to 0xFFFFFFFF.\n - * When the Target Transfer Tag is set to a value other than 0xFFFFFFFF, - * the LUN field MUST also be copied from the NOP-In. - */ - uint32_t target_xfer_tag; - - /// CmdSN. - uint32_t cmd_sn; - - /// ExpStatSN. - uint32_t exp_stat_sn; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved2[2]; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /** - * @brief DataSegment - Ping Data (optional). - * - * Ping data is reflected in the NOP-In Response. The length of the - * reflected data is limited to MaxRecvDataSegmentLength. The length of - * ping data is indicated by the DataSegmentLength. 0 is a valid value - * for the DataSegmentLength and indicates the absence of ping data. - */ - iscsi_scsi_ds_cmd_data ds_ping_data; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 0x00 according to iSCSI specification. + uint8_t opcode; + + /// Reserved for future usage (must be always 0x80 for now). + int8_t flags; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved; + + /// TotalAHSLength. + uint8_t total_ahs_len; + + /// DataSegmentLength. + uint8_t ds_len[3]; + + /// LUN or Reserved. + uint64_t lun; + + /** + * @brief Initiator Task Tag (ITT). + * + * The NOP-Out MUST have the Initiator Task Tag set to a valid value + * only if a response in the form of a NOP-In is requested (i.e., the + * NOP-Out is used as a ping request). Otherwise, the Initiator Task + * Tag MUST be set to 0xFFFFFFFF.\n + * When a target receives the NOP-Out with a valid Initiator Task Tag, + * it MUST respond with a NOP-In Response.\n + * If the Initiator Task Tag contains 0xFFFFFFFF, the I bit MUST be set + * to 1, and the CmdSN is not advanced after this PDU is sent. + */ + uint32_t init_task_tag; + + /** + * @brief Target Transfer Tag (TTT). + * + * The Target Transfer Tag is a target-assigned identifier for the + * operation.\n + * The NOP-Out MUST only have the Target Transfer Tag set if it is + * issued in response to a NOP-In with a valid Target Transfer Tag. In + * this case, it copies the Target Transfer Tag from the NOP-In PDU.\n + * Otherwise, the Target Transfer Tag MUST be set to 0xFFFFFFFF.\n + * When the Target Transfer Tag is set to a value other than 0xFFFFFFFF, + * the LUN field MUST also be copied from the NOP-In. + */ + uint32_t target_xfer_tag; + + /// CmdSN. + uint32_t cmd_sn; + + /// ExpStatSN. + uint32_t exp_stat_sn; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved2[2]; + + /// Optional header digest. + uint32_t hdr_digest; + + /** + * @brief DataSegment - Ping Data (optional). + * + * Ping data is reflected in the NOP-In Response. The length of the + * reflected data is limited to MaxRecvDataSegmentLength. The length of + * ping data is indicated by the DataSegmentLength. 0 is a valid value + * for the DataSegmentLength and indicates the absence of ping data. + */ + iscsi_scsi_ds_cmd_data ds_ping_data; + + /// Optional data digest. + uint32_t data_digest; } iscsi_nop_out_packet; @@ -9653,70 +5378,70 @@ typedef struct __attribute__((packed)) iscsi_nop_out_packet { * (DataSegmentLength MUST be 0). */ typedef struct __attribute__((packed)) iscsi_nop_in_packet { - /// Always 0x20 according to iSCSI specification. - uint8_t opcode; - - /// Reserved for future usage (always MUST be 0x80 for now). - int8_t flags; - - /// Reserved for future usage, always MUST be 0. - uint16_t reserved; - - /// TotalAHSLength - uint8_t total_ahs_len; - - /// DataSegmentLength. - uint8_t ds_len[3]; - - /// A LUN MUST be set to a correct value when the Target Transfer Tag is valid (not the reserved value 0xFFFFFFFF). - uint64_t lun; - - /// Initiator Task Tag (ITT) or 0xFFFFFFFF. - uint32_t init_task_tag; - - /** - * @brief Target Transfer Tag (TTT). - * - * If the target is responding to a NOP-Out, this field is set to the - * reserved value 0xFFFFFFFF.\n - * If the target is sending a NOP-In as a ping (intending to receive a - * corresponding NOP-Out), this field is set to a valid value (not the - * reserved value 0xFFFFFFFF).\n - * If the target is initiating a NOP-In without wanting to receive a - * corresponding NOP-Out, this field MUST hold the reserved value - * 0xFFFFFFFF. - */ - uint32_t target_xfer_tag; - - /** - * @brief StatSN. - * - * The StatSN field will always contain the next StatSN. However, when - * the Initiator Task Tag is set to 0xFFFFFFFF, the StatSN for the - * connection is not advanced after this PDU is sent. - */ - uint32_t stat_sn; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /// Reserved for future usage, always MUST be 0. - uint32_t reserved2; - - /// Reserved for future usage, always MUST be 0. - uint64_t reserved3; - - /// Optional header digest. - iscsi_header_digest hdr_digest; - - /// DataSegment - Return Ping Data. - iscsi_scsi_ds_cmd_data ds_ping_data; - - /// Optional data digest. - iscsi_data_digest data_digest; + /// Always 0x20 according to iSCSI specification. + uint8_t opcode; + + /// Reserved for future usage (must be always 0x80 for now). + int8_t flags; + + /// Reserved for future usage, always MUST be 0. + uint16_t reserved; + + /// TotalAHSLength + uint8_t total_ahs_len; + + /// DataSegmentLength. + uint8_t ds_len[3]; + + /// A LUN MUST be set to a correct value when the Target Transfer Tag is valid (not the reserved value 0xFFFFFFFF). + uint64_t lun; + + /// Initiator Task Tag (ITT) or 0xFFFFFFFF. + uint32_t init_task_tag; + + /** + * @brief Target Transfer Tag (TTT). + * + * If the target is responding to a NOP-Out, this field is set to the + * reserved value 0xFFFFFFFF.\n + * If the target is sending a NOP-In as a ping (intending to receive a + * corresponding NOP-Out), this field is set to a valid value (not the + * reserved value 0xFFFFFFFF).\n + * If the target is initiating a NOP-In without wanting to receive a + * corresponding NOP-Out, this field MUST hold the reserved value + * 0xFFFFFFFF. + */ + uint32_t target_xfer_tag; + + /** + * @brief StatSN. + * + * The StatSN field will always contain the next StatSN. However, when + * the Initiator Task Tag is set to 0xFFFFFFFF, the StatSN for the + * connection is not advanced after this PDU is sent. + */ + uint32_t stat_sn; + + /// ExpCmdSN. + uint32_t exp_cmd_sn; // ExpCmdSN + + /// MaxCmdSN. + uint32_t max_cmd_sn; + + /// Reserved for future usage, always MUST be 0. + uint32_t reserved2; + + /// Reserved for future usage, always MUST be 0. + uint64_t reserved3; + + /// Optional header digest. + uint32_t hdr_digest; + + /// DataSegment - Return Ping Data. + iscsi_scsi_ds_cmd_data ds_ping_data; + + /// Optional data digest. + uint32_t data_digest; } iscsi_nop_in_packet; @@ -9764,17 +5489,17 @@ typedef struct __attribute__((packed)) iscsi_nop_in_packet { * identifier data. */ typedef struct __attribute__((packed)) iscsi_transport_id { - /// First 4 bits are protocol ID and last 2 bits are format. - uint8_t id; + /// First 4 bits are protocol ID and last 2 bits are format. + uint8_t id; - /// Reserved for future usage (always MUST be 0). - uint8_t reserved; + /// Reserved for future usage (always MUST be 0). + uint8_t reserved; - /// Additional length of name. - uint16_t add_len; + /// Additional length of name. + uint16_t add_len; - /// Name. - uint8_t name[0]; + /// Name. + uint8_t name[0]; } iscsi_transport_id; @@ -9854,20 +5579,20 @@ typedef struct __attribute__((packed)) iscsi_transport_id { * and the iSCSI connection lookup table. */ typedef struct iscsi_key_value_pair_lut_entry { - /// Name of key. - const uint8_t *key; + /// Name of key. + const uint8_t *key; - /// Default value of the key, always in string representation. - uint8_t *value; + /// Default value of the key, always in string representation. + uint8_t *value; - /// NUL separated list of allowed string values. If key type is numeric: NUL separated minimum and maximum integer range. End is marked with another NUL. - uint8_t *list_range; + /// NUL separated list of allowed string values. If key type is numeric: NUL separated minimum and maximum integer range. End is marked with another NUL. + uint8_t *list_range; - /// Type of key and value pair. - const int type; + /// Type of key and value pair. + const int type; - /// Flags indicating special key attributes. - const int flags; + /// Flags indicating special key attributes. + const int flags; } iscsi_key_value_pair_lut_entry; @@ -9879,19 +5604,19 @@ typedef struct iscsi_key_value_pair_lut_entry { * Text or Login packet data. */ typedef struct iscsi_key_value_pair { - /// Value of the key which is stored in the hash map. + /// Value of the key which is stored in the hash map. uint8_t *value; - /// NUL separated list of allowed string values. If key type is numeric: NUL separated minimum and maximum integer range. End is marked with another NUL. - uint8_t *list_range; + /// NUL separated list of allowed string values. If key type is numeric: NUL separated minimum and maximum integer range. End is marked with another NUL. + uint8_t *list_range; - /// Type of key and value pair. - int type; + /// Type of key and value pair. + int type; - /// Flags indicating special key attributes. - int flags; + /// Flags indicating special key attributes. + int flags; - /// State bit mask. + /// State bit mask. uint state_mask; } iscsi_key_value_pair; @@ -9904,530 +5629,37 @@ typedef struct iscsi_connection iscsi_connection; * pairs for sending as DataSegment packet data to the client. */ typedef struct iscsi_key_value_pair_packet { - /// Associated iSCSI connection. - iscsi_connection *conn; + /// Associated iSCSI connection. + iscsi_connection *conn; - /// Current text buffer containing multiple key=value + NUL terminator pairs. - uint8_t *buf; + /// Current text buffer containing multiple key=value + NUL terminator pairs. + uint8_t *buf; - /// Position of output buffer for next write. - uint32_t pos; + /// Position of output buffer for next write. + uint32_t pos; - /// Current length of buffer including final NUL terminator without iSCSI zero padding. - uint32_t len; + /// Current length of buffer including final NUL terminator without iSCSI zero padding. + uint32_t len; - /// Discovery mode. - int discovery; + /// Discovery mode. + int discovery; } iscsi_key_value_pair_packet; -int iscsi_parse_key_value_pairs(iscsi_hashmap *key_value_pairs, const uint8_t *packet_data, uint len, int c_bit, uint8_t **partial_pairs); // Extracts all text key / value pairs out of an iSCSI packet into a hash map - - -/// iSCSI main global data: INI configuration filename. -#define ISCSI_GLOBALS_CONFIG_FILENAME "iscsi.conf" - - -/// iSCSI main global data: iSCSI INI configuration iSCSI section identifier string. -#define ISCSI_GLOBALS_SECTION_ISCSI "iscsi" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI "scsi" - - -/// iSCSI main global data: iSCSI INI configuration iSCSI section target name check key identifier string. -#define ISCSI_GLOBALS_SECTION_ISCSI_KEY_TARGET_NAME_CHECK "TargetNameCheck" - -/// iSCSI main global data: iSCSI INI configuration iSCSI section maximum number of sessions allowed key identifier string. -#define ISCSI_GLOBALS_SECTION_ISCSI_KEY_MAX_SESSIONS "MaxSessions" - -/// iSCSI main global data: iSCSI INI configuration iSCSI section maximum number of connections per session allowed key identifier string. -#define ISCSI_GLOBALS_SECTION_ISCSI_MAX_CONNECTIONS_PER_SESSIONS "MaxConnectionsPerSession" - - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section device type key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_DEVICE_TYPE "DeviceType" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section physical block size key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_PHYSICAL_BLOCK_SIZE "PhysicalBlockSize" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section logical block size key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_LOGICAL_BLOCK_SIZE "LogicalBlockSize" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section removable device key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_REMOVABLE "Removable" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section UNMAP support device key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_UNMAP "UNMAP" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section no rotation device key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_NO_ROTATION "NoRotation" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section physical read only device key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_PHYSICAL_READ_ONLY "PhysicalReadOnly" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section write protected device key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_WRITE_PROTECT "WriteProtect" - -/// iSCSI main global data: iSCSI INI configuration iSCSI SCSI section write cache supported device key identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_KEY_WRITE_CACHE "WriteCache" - - -/// iSCSI main global data: iSCSI SCSI device specific INI configuration section prefix identifier string. -#define ISCSI_GLOBALS_SECTION_SCSI_DEVICE_PREFIX "scsi-device-" - - -/// iSCSI main global data config type: iHeader digest (CRC32), always MUST be 0 or 4 for now. -#define ISCSI_GLOBALS_CONFIG_TYPE_HEADER_DIGEST 0 - -/// iSCSI main global data config type: Data digest (CRC32), always MUST be 0 or 4 for now. -#define ISCSI_GLOBALS_CONFIG_TYPE_DATA_DIGEST 1 - -/// iSCSI main global data config type: Maximum receive DataSegment length in bytes. -#define ISCSI_GLOBALS_CONFIG_TYPE_MAX_RECV_DS_LEN 2 - -/// iSCSI main global data config type: Maximum number of connections per session. -#define ISCSI_GLOBALS_CONFIG_TYPE_MAX_SESSION_CONNS 3 - -/// iSCSI main global data config type: Ready to transfer maximum outstanding value. -#define ISCSI_GLOBALS_CONFIG_TYPE_MAX_OUTSTANDING_R2T 4 - -/// iSCSI main global data config type: Default time to wait. -#define ISCSI_GLOBALS_CONFIG_TYPE_DEFAULT_TIME_TO_WAIT 5 - -/// iSCSI main global data config type: Default time to retain. -#define ISCSI_GLOBALS_CONFIG_TYPE_DEFAULT_TIME_TO_RETAIN 6 - -/// iSCSI main global data config type: First burst length. -#define ISCSI_GLOBALS_CONFIG_TYPE_FIRST_BURST_LEN 7 - -/// iSCSI main global data config type: Maximum burst length. -#define ISCSI_GLOBALS_CONFIG_TYPE_MAX_BURST_LEN 8 - -/// iSCSI main global data config type: Error recovery level. -#define ISCSI_GLOBALS_CONFIG_TYPE_ERR_RECOVERY_LEVEL 9 - -/// iSCSI main global data config type: SCSI emulation for device type. -#define ISCSI_GLOBALS_CONFIG_TYPE_SCSI_DEVICE_TYPE 10 - -/// iSCSI main global data config type: SCSI emulation for physical block size. -#define ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE 11 - -/// iSCSI main global data config type: SCSI emulation for physical block size shift count. -#define ISCSI_GLOBALS_CONFIG_TYPE_SCSI_PHYSICAL_BLOCK_SIZE_SHIFT 12 - -/// iSCSI main global data config type: SCSI emulation for logical block size. -#define ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE 13 - -/// iSCSI main global data config type: SCSI emulation for logical block size shift count. -#define ISCSI_GLOBALS_CONFIG_TYPE_SCSI_LOGICAL_BLOCK_SIZE_SHIFT 14 - -/// iSCSI main global data config type: Initial ready to transfer. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_INIT_R2T 15 - -/// iSCSI main global data config type: Immediate data. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_IMMEDIATE_DATA 16 - -/// iSCSI main global data config type: Data PDU in order. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_DATA_PDU_IN_ORDER 17 - -/// iSCSI main global data config type: Data sequence in order. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_DATA_SEQ_IN_ORDER 18 - -/// iSCSI main global data config type: SCSI emulation for I/O removable device. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_REMOVABLE 19 - -/// iSCSI main global data config type: SCSI emulation for I/O UNMAP supporting device. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_UNMAP 20 - -/// iSCSI main global data config type: SCSI emulation for I/O non-rotating device. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_NO_ROTATION 21 - -/// iSCSI main global data config type: SCSI emulation for I/O physical read only device. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY 22 - -/// iSCSI main global data config type: SCSI emulation for I/O write protected device. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_PROTECT 23 - -/// iSCSI main global data config type: SCSI emulation for I/O write cache device. -#define ISCSI_GLOBALS_CONFIG_TYPE_FLAGS_SCSI_IO_WRITE_CACHE 24 - - -/// iSCSI main global data SCSI device configuration flags: Initial ready to transfer. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_INIT_R2T (1 << 0) - -/// iSCSI main global data SCSI device configuration flags: Immediate data. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_IMMEDIATE_DATA (1 << 1) - -/// iSCSI main global data SCSI device configuration flags: Data PDU in order. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_DATA_PDU_IN_ORDER (1 << 2) - -/// iSCSI main global data SCSI device configuration flags: Data sequence in order. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_DATA_SEQ_IN_ORDER (1 << 3) - -/// iSCSI main global data SCSI device configuration flags: SCSI emulation for I/O removable device. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_REMOVABLE (1 << 4) - -/// iSCSI main global data SCSI device configuration flags: SCSI emulation for I/O UNMAP supporting device. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_UNMAP (1 << 5) - -/// iSCSI main global data SCSI device configuration flags: SCSI emulation for I/O non-rotating device. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_NO_ROTATION (1 << 6) - -/// iSCSI main global data SCSI device configuration flags: SCSI emulation for I/O physical read only device. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY (1 << 7) - -/// iSCSI main global data SCSI device configuration flags: SCSI emulation for I/O write protected device. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_PROTECT (1 << 8) - -/// iSCSI main global data SCSI device configuration flags: SCSI emulation for I/O write cache device. -#define ISCSI_GLOBALS_SCSI_DEVICE_CONFIG_FLAGS_SCSI_IO_WRITE_CACHE (1 << 9) - - -/** - * @brief iSCSI main global data SCSI device configuration. - * - * This structure is used for specific SCSI device - * configuration which are matched using wildcard - * patterns which are stored in the hash map key. - */ -typedef struct iscsi_scsi_device_config { - /// SCSI device configuration flags. - int flags; - - /// iHeader digest (CRC32), always MUST be 0 or 4 for now. - int header_digest; - - /// Data digest (CRC32), always MUST be 0 or 4 for now. - int data_digest; - - /// SCSI emulation: Device type. - uint scsi_device_type; - - /// Maximum receive DataSegment length in bytes. - uint32_t max_recv_ds_len; - - /// Maximum number of connections per session. - uint32_t max_session_conns; - - /// Ready to transfer maximum outstanding value. - uint32_t max_outstanding_r2t; - - /// Default time to wait. - uint32_t default_time_to_wait; - - /// Default time to retain. - uint32_t default_time_to_retain; - - /// First burst length. - uint32_t first_burst_len; - - /// Maximum burst length. - uint32_t max_burst_len; - - /// Error recovery level. - uint32_t err_recovery_level; - - /// SCSI emulation: Physical block size. - uint32_t scsi_physical_block_size; - - /// SCSI emulation: Physical block size shift count. - uint32_t scsi_physical_block_size_shift; - - /// SCSI emulation: Logical block size. - uint32_t scsi_logical_block_size; - - /// SCSI emulation: Logical block size shift count. - uint32_t scsi_logical_block_size_shift; -} iscsi_scsi_device_config; - - -/** - * @brief iSCSI SCSI device configuration search by name. - * - * This structure is used by iterating through - * all iSCSI SCSI device configurations and - * uses wildcard matching in order to retrieve - * the correct SCSI configuration for a - * specified device name. - */ -typedef struct iscsi_scsi_device_config_find { - /// Found iSCSI SCSI device configuration is stored here, should be initialized to NULL. - iscsi_scsi_device_config *scsi_device_config; - - /// The name to be searched for is stored here. - uint8_t *name; -} iscsi_scsi_device_config_find; - - /// iSCSI main global data flags: Allow duplicate ISIDs. -#define ISCSI_GLOBALS_FLAGS_ISID_ALLOW_DUPLICATES (1 << 0) +#define ISCSI_GLOBALS_FLAGS_ISID_ALLOW_DUPLICATES (1 << 0) /// iSCSI main global data flags: CHAP authentication is disabled. -#define ISCSI_GLOBALS_FLAGS_CHAP_DISABLE (1 << 1) +#define ISCSI_GLOBALS_FLAGS_CHAP_DISABLE (1 << 1) /// iSCSI main global data flags: CHAP authentication is required. -#define ISCSI_GLOBALS_FLAGS_CHAP_REQUIRE (1 << 2) +#define ISCSI_GLOBALS_FLAGS_CHAP_REQUIRE (1 << 2) /// iSCSI main global data flags: CHAP authentication is mutual. -#define ISCSI_GLOBALS_FLAGS_CHAP_MUTUAL (1 << 3) - -/// iSCSI main global data flags: Initial ready to transfer. -#define ISCSI_GLOBALS_FLAGS_INIT_R2T (1 << 4) - -/// iSCSI main global data flags: Immediate data. -#define ISCSI_GLOBALS_FLAGS_IMMEDIATE_DATA (1 << 5) - -/// iSCSI main global data flags: Data PDU in order. -#define ISCSI_GLOBALS_FLAGS_DATA_PDU_IN_ORDER (1 << 6) - -/// iSCSI main global data flags: Data sequence in order. -#define ISCSI_GLOBALS_FLAGS_DATA_SEQ_IN_ORDER (1 << 7) - -/// iSCSI main global data flags: SCSI emulation for I/O removable device. -#define ISCSI_GLOBALS_FLAGS_SCSI_IO_REMOVABLE (1 << 8) - -/// iSCSI main global data flags: SCSI emulation for I/O UNMAP supporting device. -#define ISCSI_GLOBALS_FLAGS_SCSI_IO_UNMAP (1 << 9) - -/// iSCSI main global data flags: SCSI emulation for I/O non-rotating device. -#define ISCSI_GLOBALS_FLAGS_SCSI_IO_NO_ROTATION (1 << 10) - -/// iSCSI main global data flags: SCSI emulation for I/O physical read only device. -#define ISCSI_GLOBALS_FLAGS_SCSI_IO_PHYSICAL_READ_ONLY (1 << 11) - -/// iSCSI main global data flags: SCSI emulation for I/O write protected device. -#define ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_PROTECT (1 << 12) - -/// iSCSI main global data flags: SCSI emulation for I/O write cache device. -#define ISCSI_GLOBALS_FLAGS_SCSI_IO_WRITE_CACHE (1 << 13) - - -/// iSCSI main global data target name validation check level: None, allow everything. -#define ISCSI_GLOBALS_TARGET_NAME_CHECK_NONE 0 - -/// iSCSI main global data target name validation check level: Relaxed, check for maximum target name length and if target name starts with 'iqn.', 'naa.' or 'eui.' also check if target name only contains allowed characters. -#define ISCSI_GLOBALS_TARGET_NAME_CHECK_RELAXED 1 - -/// iSCSI main global data target name validation check level: Full, check for maximum target name length and always check target name only contains allowed characters. -#define ISCSI_GLOBALS_TARGET_NAME_CHECK_FULL 2 - - -/// iSCSI main global data: Default maximum number of connections. -#define ISCSI_GLOBALS_DEFAULT_MAX_CONNECTIONS 1UL - -/// iSCSI main global data: Default maximum number of outstanding ready to transfers. -#define ISCSI_GLOBALS_DEFAULT_MAX_OUTSTANDING_R2T 1UL - -/// iSCSI main global data: Default time to wait in seconds. -#define ISCSI_GLOBALS_DEFAULT_TIME_TO_WAIT 2UL - -/// iSCSI main global data: Default time to retain in seconds. -#define ISCSI_GLOBALS_DEFAULT_TIME_TO_RETAIN 20UL - -/// iSCSI main global data: First burst length in bytes. -#define ISCSI_GLOBALS_DEFAULT_FIRST_BURST_LEN ISCSI_DEFAULT_RECV_DS_LEN - -/// iSCSI main global data: Maximum burst length in bytes. -#define ISCSI_GLOBALS_DEFAULT_MAX_BURST_LEN (ISCSI_DEFAULT_MAX_RECV_DS_LEN * ISCSI_DEFAULT_MAX_DATA_OUT_PER_CONNECTION) +#define ISCSI_GLOBALS_FLAGS_CHAP_MUTUAL (1 << 3) -/// iSCSI main global data: Default error recovery level. -#define ISCSI_GLOBALS_DEFAULT_ERR_RECOVERY_LEVEL 0UL - - -/** - * @brief This is the main global iSCSI structure which manages all global data. - * - * All iSCSI portal groups, target nodes, sessions and - * connections are stored here for global access. - */ -typedef struct iscsi_globals { - /// Hash map containing all iSCSI devices. - iscsi_hashmap *devices; - - /// Read/write lock for hash map containing all iSCSI devices. MUST be initialized with iscsi_create before any iSCSI functions are used. - pthread_rwlock_t devices_rwlock; - - /// Hash map containing all registered iSCSI portal groups. - iscsi_hashmap *portal_groups; - - /// Read/write lock for hash map containing all iSCSI portal_groups. MUST be initialized with iscsi_create before any iSCSI functions are used. - pthread_rwlock_t portal_groups_rwlock; - - /// iSCSI target nodes. - iscsi_hashmap *target_nodes; - - /// Read/write lock for hash map containing all iSCSI target nodes. MUST be initialized with iscsi_create before any iSCSI functions are used. - pthread_rwlock_t target_nodes_rwlock; - - /// Hash map containing all iSCSI sessions. - iscsi_hashmap *sessions; - - /// Read/write lock for hash map containing all iSCSI sessions. MUST be initialized with iscsi_create before any iSCSI functions are used. - pthread_rwlock_t sessions_rwlock; - - /// Hash map containing session key and value pair types and allowed values or ranges. - iscsi_hashmap *session_key_value_pairs; - - /// Hash map containing connection key and value pair types and allowed values or ranges. - iscsi_hashmap *connection_key_value_pairs; - - /// Hash map containing iSCSI SCSI device specific configuration. - iscsi_hashmap *scsi_device_config; - - /// Mutex for hash map containing iSCSI SCSI device specific configuration. - pthread_mutex_t scsi_device_config_mutex; - - /// Global flags. - int flags; - - /// Target name validation check level. - int target_name_check; - - /// Maximum number of allowed sessions. - uint max_sessions; - - /// iHeader digest (CRC32), always MUST be 0 or 4 for now. - int header_digest; - - /// Data digest (CRC32), always MUST be 0 or 4 for now. - int data_digest; - - /// SCSI emulation: Device type. - uint scsi_device_type; - - /// Maximum receive DataSegment length in bytes. - uint32_t max_recv_ds_len; - - /// Maximum number of connections per session. - uint32_t max_session_conns; - - /// Ready to transfer maximum outstanding value. - uint32_t max_outstanding_r2t; - - /// Default time to wait. - uint32_t default_time_to_wait; - - /// Default time to retain. - uint32_t default_time_to_retain; - - /// First burst length. - uint32_t first_burst_len; - - /// Maximum burst length. - uint32_t max_burst_len; - - /// Error recovery level. - uint32_t err_recovery_level; - - /// CHAP group id. - int32_t chap_group; - - /// SCSI emulation: Physical block size. - uint32_t scsi_physical_block_size; - - /// SCSI emulation: Physical block size shift count. - uint32_t scsi_physical_block_size_shift; - - /// SCSI emulation: Logical block size. - uint32_t scsi_logical_block_size; - - /// SCSI emulation: Logical block size shift count. - uint32_t scsi_logical_block_size_shift; -} iscsi_globals; - - -/// Reference to iSCSI global vector. MUST be initialized with iscsi_create before any iSCSI functions are used. -extern iscsi_globals *iscsi_globvec; /// Read/write lock for iSCSI global vector. MUST be initialized with iscsi_create before any iSCSI functions are used. -extern pthread_rwlock_t iscsi_globvec_rwlock; - - -int iscsi_create(); // Allocates and initializes the iSCSI global vector structure -void iscsi_destroy(); // Deallocates all resources acquired by iscsi_create - -int iscsi_config_load(iscsi_globals *globvec); // Loads iSCSI server configuration from INI file -int iscsi_config_get_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Finds an iSCSI SCSI device configuration by name using pattern matching -int32_t iscsi_config_get(uint8_t *name, const int type); // Retrieves a configuration value either from the iSCSI global vector or for a specified SCSI device name - - -/** - * @brief iSCSI portal group: Private portal group if set, public otherwise. - * - * When redirecting logins, there are two portal group types: public and - * private.\n - * Public portal groups return their portals during discovery session. - * A redirection private portal may also be specified for non-discovery - * logins.\n - * Private portal groups instead do not return their portals during - * the discovery session. - */ -#define ISCSI_PORTAL_GROUP_PRIVATE (1 << 0) - -/// iSCSI portal group: CHAP authentication is disabled. -#define ISCSI_PORTAL_GROUP_CHAP_DISABLE (1 << 1) - -/// iSCSI portal group: CHAP authentication is required. -#define ISCSI_PORTAL_GROUP_CHAP_REQUIRE (1 << 2) - -/// iSCSI portal group: CHAP authentication is mutual. -#define ISCSI_PORTAL_GROUP_CHAP_MUTUAL (1 << 3) - - -/** - * @brief iSCSI portal group. - * - * Portal groups are either public or private and also are used - * by CHAP authentication. - */ -typedef struct iscsi_portal_group { - /// Hash map containing all portals associated with this iSCSI group. - iscsi_hashmap *portals; - - /// Tag value for this portal group. - uint64_t tag; - - /// Reference count. - int ref_count; - - /// Portal group flags. - int flags; - - /// CHAP group id. - int32_t chap_group; -} iscsi_portal_group; - - -/** - * @brief iSCSI portal. - * - * iSCSI portals manage the host / IP address and port, as well - * as the associated connections. - */ -typedef struct iscsi_portal { - /// Group this portal belongs to. - iscsi_portal_group *group; - - /// Hostname / IP address of the portal. - uint8_t *host; - - /// Port of the portal. - uint8_t *port; - - /// TCP/IP socket for the portal. - int sock; -} iscsi_portal; - - -iscsi_portal_group *iscsi_portal_group_create(const uint64_t tag, const int flags); // Creates and initializes an iSCSI portal group -int iscsi_portal_group_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI portal group destructor callback for hash map -void iscsi_portal_group_destroy(iscsi_portal_group *portal_group); // Deallocates resources acquired by iscsi_portal_group_create -int iscsi_portal_group_add_portal(iscsi_portal_group *portal_group, iscsi_portal *portal); // Adds an iSCSI portal to the iSCSI portal group hash map -void iscsi_portal_group_del_portal(iscsi_portal_group *portal_group, iscsi_portal *portal); // Removes an iSCSI portal from the iSCSI portal group hash map - -iscsi_portal *iscsi_portal_create(const uint8_t *host, const uint8_t *port); // Allocates and initializes an iSCSI portal structure -int iscsi_portal_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI portal destructor callback for hash map -void iscsi_portal_destroy(iscsi_portal *portal); +//extern pthread_rwlock_t iscsi_globvec_rwlock; /// iSCSI SCSI status code: Good. @@ -10602,41 +5834,6 @@ void iscsi_portal_destroy(iscsi_portal *portal); #define ISCSI_SCSI_ASCQ_CAPACITY_DATA_HAS_CHANGED 0x09 -typedef struct iscsi_port iscsi_port; - - -/** - * @brief iSCSI SCSI Persistent Reservation (PR) registrant with I_T nexus. - * - * I_T nexus is a nexus which exists between an initiator and a - * target. - */ -typedef struct iscsi_scsi_pr_registrant { - /// Target iSCSI port. - iscsi_port *target_port; - - /// Target iSCSI port name. - uint8_t *target_name; - - /// Initiator iSCSI port. - iscsi_port *init_port; - - /// Initiator iSCSI port name. - uint8_t *init_name; - - /// Transport ID. - iscsi_transport_id *transport_id; - - /// Reservation key. - uint64_t r_key; - - /// Relative target port identifier. - uint16_t rel_target_port_id; - - /// Transport ID length. - uint16_t transport_id_len; -} iscsi_scsi_pr_registrant; - /// iSCSI SCSI Persistent Reservation (PR) reservation type: Write exclusive. #define ISCSI_SCSI_PR_RESERVATION_TYPE_WRITE_EXCLUSIVE 0x01 @@ -10661,47 +5858,6 @@ typedef struct iscsi_scsi_pr_registrant { #define ISCSI_SCSI_PR_RESERVATION_FLAGS_SPC2_RESERVE (1L << 0L) -/** - * @brief iSCSI SCSI Persistent Reservation (PR) reservation with LU_SCOPE. - * - * LU_SCOPE means that Persistent Reservation (PR) scope - * applies to the full logical unit. - */ -typedef struct iscsi_scsi_pr_reservation { - /// Registrant for this reservation. - iscsi_scsi_pr_registrant *holder; - - /// Current reservation key. - uint64_t cr_key; - - /// Reservation type. - int type; - - /// Reservation flags. - int32_t flags; -} iscsi_scsi_pr_reservation; - - -/** - * @brief iSCSI SCSI Persistent Reservation (PR) registrant search by target and initiator port. - * - * This structure is used by iterating through - * all iSCSI LUN Persistent Reservation (PR) - * registrant's finding by target and initiator - * port. - */ -typedef struct iscsi_scsi_pr_registrant_get_reg { - /// Found iSCSI SCSI Persistent Reservation (PR) registrant is stored here, should be initialized to NULL. - iscsi_scsi_pr_registrant *reg; - - /// The target port to be searched for is stored here. - iscsi_port *target_port; - - /// The initiator port to be searched for is stored here. - iscsi_port *init_port; -} iscsi_scsi_pr_registrant_get_reg; - - /// iSCSI SCSI task run: Unknown. #define ISCSI_SCSI_TASK_RUN_UNKNOWN -1 @@ -10715,70 +5871,6 @@ typedef struct iscsi_scsi_pr_registrant_get_reg { typedef struct iscsi_scsi_task iscsi_scsi_task; typedef struct iscsi_scsi_lun iscsi_scsi_lun; - -/** - * @brief Callback when iSCSI SCSI transfer task completed. - * - * This function is invoked when an iSCSI task - * finished a transfer. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task which - * completed the transfer and may NOT be NULL, - * so be careful. - */ -typedef void (*iscsi_scsi_task_xfer_complete_callback)(iscsi_scsi_task *scsi_task); - -/** - * @brief Callback when iSCSI SCSI transfer task destruction. - * - * This function is invoked when an iSCSI task - * needs to be destroyed. - * - * @param[in] scsi_task Pointer to iSCSI SCSI task which - * is about to be destroyed and may NOT be - * NULL, so be careful. - */ -typedef void (*iscsi_scsi_task_destroy_callback)(iscsi_scsi_task *scsi_task); - -/** - * @brief Callback for I/O operation completion. - * - * This function is invoked when an I/O operation - * has been completed. - * - * @param[in] image Pointer to DNBD3 image which completed the - * I/O operation. - * @param[in] user_data Pointer to user data. - * @param[in] success true if I/O completed successfully or false - * if it failed instead. - * @return Pointer to passed user data. - */ -typedef uint8_t *(*iscsi_scsi_emu_io_complete_callback)(dnbd3_image_t *image, uint8_t *user_data, const bool success); - -/** - * @brief Callback for I/O wait operation. - * - * This function is invoked when an I/O - * operation needs waiting. - * - * @param[in] user_data Pointer to user data. - * @return Pointer to passed user data. - */ -typedef uint8_t *(*iscsi_scsi_emu_io_wait_callback)(uint8_t *user_data); - - -typedef struct iscsi_scsi_emu_io_wait { - /// I/O task wait callback associated DNBD3 image. - dnbd3_image_t *image; - - /// I/O task wait callback function. - iscsi_scsi_emu_io_wait_callback callback; - - /// I/O task wait callback user data. - uint8_t *user_data; -} iscsi_scsi_emu_io_wait; - - /// iSCSI SCSI task flags: Read. #define ISCSI_SCSI_TASK_FLAGS_XFER_READ (1 << 0) @@ -10793,96 +5885,58 @@ typedef struct iscsi_scsi_emu_io_wait { * layer task management. */ typedef struct iscsi_scsi_task { - /// Doubly linked list node, MUST be first element. - iscsi_node node; - - /// SCSI LUN associated with this task. - iscsi_scsi_lun *lun; - - /// Target iSCSI port. - iscsi_port *target_port; - - /// Initiator iSCSI port. - iscsi_port *init_port; - - /// SCSI Command Descriptor Block (CDB). - iscsi_scsi_cdb *cdb; - - /// SCSI sense data. - iscsi_scsi_sense_data_packet *sense_data; - - /// Transfer complete callback function. - iscsi_scsi_task_xfer_complete_callback xfer_complete_callback; - - /// Task destruction callback function. - iscsi_scsi_task_destroy_callback destroy_callback; - - /// I/O task complete callback function. - iscsi_scsi_emu_io_complete_callback io_complete_callback; + /// Connection associated with this task. + iscsi_connection *connection; - /// I/O task wait. - iscsi_scsi_emu_io_wait io_wait; + /// SCSI Command Descriptor Block (CDB). + iscsi_scsi_cdb *cdb; - /// Uplink read mutex for synchronization. - pthread_mutex_t uplink_mutex; + /// SCSI sense data. + iscsi_scsi_sense_data_packet *sense_data; - /// Conditional to signal uplink read complete. - pthread_cond_t uplink_cond; + /// Output buffer. + uint8_t *buf; - /// Output buffer. - uint8_t *buf; + /// Position of buffer in bytes. + uint32_t pos; - /// Position of buffer in bytes. - uint32_t pos; + /// Length of buffer in bytes. + uint32_t len; - /// Length of buffer in bytes. - uint32_t len; + /// Unique identifier for this task. + uint64_t id; - /// Unique identifier for this task. - uint64_t id; + /// Flags. + int flags; - /// Flags. - int flags; + /// Transfer position in bytes. + uint32_t xfer_pos; - /// Reference counter. - uint32_t ref; + /// Transfer length in bytes. + uint32_t xfer_len; - /// Transfer position in bytes. - uint32_t xfer_pos; + /// Sense data length. + uint8_t sense_data_len; - /// Transfer length in bytes. - uint32_t xfer_len; + /// iSCSI SCSI status code. + uint8_t status; - /// Sense data length. - uint8_t sense_data_len; + /// Uplink read mutex for sync + pthread_mutex_t uplink_mutex; - /// iSCSI SCSI status code. - uint8_t status; - - /// Task management function. - uint8_t task_mgmt_func; - - /// Task management response code. - uint8_t task_mgmt_response; + /// Conditional to signal uplink read complete + pthread_cond_t uplink_cond; } iscsi_scsi_task; /// iSCSI SCSI emulation physical block size in bytes. -#define ISCSI_SCSI_EMU_PHYSICAL_BLOCK_SIZE 4096UL +#define ISCSI_SCSI_EMU_PHYSICAL_BLOCK_SIZE DNBD3_BLOCK_SIZE /// iSCSI SCSI emulation logical block size in bytes. -#define ISCSI_SCSI_EMU_BLOCK_SIZE 512UL - - -/// iSCSI SCSI emulation maximum tansfer length in logical blocks. -#define ISCSI_SCSI_EMU_MAX_XFER_LEN (ISCSI_DEFAULT_MAX_RECV_DS_LEN * ISCSI_DEFAULT_MAX_DATA_OUT_PER_CONNECTION) - -/// iSCSI SCSI emulation maximum UNMAP LBA count in LBAs. -#define ISCSI_SCSI_EMU_MAX_UNMAP_LBA_COUNT (ISCSI_DEFAULT_MAX_RECV_DS_LEN * ISCSI_DEFAULT_MAX_DATA_IN_PER_CONNECTION) - -/// iSCSI SCSI emulation maximum UNMAP block descriptor count in block descriptors. -#define ISCSI_SCSI_EMU_MAX_UNMAP_BLOCK_DESC_COUNT 256UL +#define ISCSI_SCSI_EMU_BLOCK_SIZE (512) +/// Block shift difference between dnbd3 (4k) and iSCSI (512b) +#define ISCSI_SCSI_EMU_BLOCK_DIFF_SHIFT (3) /// iSCSI SCSI emulation I/O type: Removable. #define ISCSI_SCSI_EMU_IO_TYPE_REMOVABLE (1 << 0) @@ -10899,9 +5953,6 @@ typedef struct iscsi_scsi_task { /// iSCSI SCSI emulation I/O type: Device is (temporarily) write protected. #define ISCSI_SCSI_EMU_IO_TYPE_WRITE_PROTECT (1 << 4) -/// iSCSI SCSI emulation I/O type: Write cache available. -#define ISCSI_SCSI_EMU_IO_TYPE_WRITE_CACHE (1 << 5) - /// iSCSI SCSI emulation block flags: Write operation. #define ISCSI_SCSI_EMU_BLOCK_FLAGS_WRITE (1 << 0) @@ -10910,332 +5961,79 @@ typedef struct iscsi_scsi_task { #define ISCSI_SCSI_EMU_BLOCK_FLAGS_VERIFY (1 << 1) -void iscsi_scsi_task_create(iscsi_scsi_task *scsi_task, iscsi_scsi_task_xfer_complete_callback xfer_complete_callback, iscsi_scsi_task_destroy_callback destroy_callback); // Allocates and initializes a SCSI task -void iscsi_scsi_task_destroy(iscsi_scsi_task *scsi_task); // Deallocates all resources acquired iscsi_scsi_task_create - -void iscsi_scsi_task_xfer_complete(iscsi_scsi_task *scsi_task); // Callback function when an iSCSI SCSI task completed the data transfer - -void iscsi_scsi_task_sense_data_check_cond_build(iscsi_scsi_task *scsi_task, const uint8_t sense_key, const uint8_t asc, const uint8_t ascq); // Allocates, if necessary and initializes SCSI sense data for check condition status code -int iscsi_scsi_task_status_copy(iscsi_scsi_task *dst_scsi_task, const iscsi_scsi_task *src_scsi_task); // Copies iSCSI SCSI task sense data and status code -void iscsi_scsi_task_lun_process_none(iscsi_scsi_task *scsi_task); // Processes a iSCSI SCSI task with no LUN identifier -void iscsi_scsi_task_lun_process_abort(iscsi_scsi_task *scsi_task); // Processes a iSCSI SCSI aborted task - -iscsi_scsi_lun *iscsi_scsi_lun_create(const int lun_id); // Allocates and initializes an iSCSI LUN structure for linkage with a DNBD3 image -int iscsi_scsi_lun_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI SCSI LUN destructor callback for hash map -void iscsi_scsi_lun_destroy(iscsi_scsi_lun *lun); // Deallocates all resources acquired by iscsi_scsi_lun_create - -uint64_t iscsi_scsi_lun_get_from_scsi(const int lun_id); // Converts an internal representation of a LUN identifier to an iSCSI LUN required for packet data -int iscsi_scsi_lun_get_from_iscsi(const uint64_t lun); // Converts an iSCSI LUN from packet data to internal SCSI LUN identifier - -void iscsi_scsi_lun_task_append(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task); // Appends an iSCSI SCSI task to a iSCSI SCSI LUN pending tasks doubly linked list -void iscsi_scsi_lun_tasks_exec(iscsi_scsi_lun *lun); // Executes all iSCSI SCSI pending tasks assigned to a iSCSI SCSI LUN -void iscsi_scsi_lun_task_run(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task); // Runs an iSCSI SCSI task for a specified iSCSI SCSI LUN -void iscsi_scsi_lun_task_complete(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task); // Handles iSCSI SCSI task completition -void iscsi_scsi_lun_task_exec(iscsi_scsi_lun *lun, iscsi_scsi_task *scsi_task); // Appends iSCSI SCSI task to pending tasks doubly linked list and / or runs it directly - -int iscsi_scsi_pr_check_scsi2(iscsi_scsi_task *scsi_task); // Checks the iSCSI SCSI Persistent Reservation (PR) SCSI-2 reserve of an iSCSI SCSI task -int iscsi_scsi_pr_registrant_get_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Finds an iSCSI SCSI Persistent Reservation (PR) registrant by target and initiator port -int iscsi_scsi_pr_check(iscsi_scsi_task *scsi_task); // Checks the iSCSI SCSI Persistent Reservation (PR) of an iSCSI SCSI task -int iscsi_scsi_pr_out(iscsi_scsi_task *scsi_task, iscsi_scsi_pr_reserve_out_parameter_list_packet *pr_reserve_out_parameter_list, const iscsi_scsi_cdb_pr_reserve_out *cdb_pr_reserve_out, const uint len); // Constructs an iSCSI SCSI Persistent Reservation (PR) out parameter list of an iSCSI SCSI task -int iscsi_scsi_pr_in(iscsi_scsi_task *scsi_task, iscsi_scsi_pr_reserve_in_parameter_data_packet *pr_reserve_in_parameter_data, const iscsi_scsi_cdb_pr_reserve_in *cdb_pr_reserve_in, const uint len); // Constructs iSCSI SCSI Persistent Reservation (PR) in parameter data of an iSCSI SCSI task -int iscsi_scsi_pr_reserve_scsi2(iscsi_scsi_task *scsi_task, const iscsi_scsi_cdb_pr_reserve_6 *cdb_pr_reserve_6); // Reserves an iSCSI SCSI Persistent Reservation (PR) of an iSCSI SCSI task -int iscsi_scsi_pr_release_scsi2(iscsi_scsi_task *scsi_task); // Releases an iSCSI SCSI Persistent Reservation (PR) of an iSCSI SCSI task - -int iscsi_scsi_emu_io_block_read(iscsi_scsi_task *scsi_task, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks, const uint32_t block_size, iscsi_scsi_emu_io_complete_callback callback, uint8_t *user_data); // Reads a number of blocks from a block offset of a DNBD3 image to a specified buffer -uint8_t *iscsi_scsi_emu_block_read_complete_callback(dnbd3_image_t *image, uint8_t *user_data, const bool success); // Completes an iSCSI SCSI task after a finished I/O read operation -int iscsi_scsi_emu_io_block_cmp_write(iscsi_scsi_task *scsi_task, uint8_t *cmp_buf, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks, const uint32_t block_size, iscsi_scsi_emu_io_complete_callback callback, uint8_t *user_data); // Compares and writes a number of blocks starting from a block offset in a DNBD3 image with specified buffers -uint8_t *iscsi_scsi_emu_block_write_complete_callback(dnbd3_image_t *image, uint8_t *user_data, const bool success); // Completes an iSCSI SCSI task after a finished I/O write operation -int iscsi_scsi_emu_io_block_write(iscsi_scsi_task *scsi_task, dnbd3_image_t *image, const uint64_t offset_blocks, const uint64_t num_blocks, const uint32_t block_size, iscsi_scsi_emu_io_complete_callback callback, uint8_t *user_data); // Writes a number of blocks from a block offset to a DNBD3 image of a specified buffer -int iscsi_scsi_emu_io_queue(iscsi_scsi_emu_io_wait *io_wait); // Enqueues an I/O wait in the thread pool to execute -uint8_t *iscsi_scsi_emu_block_resubmit_process_callback(uint8_t *user_data); // Resubmits an iSCSI SCSI task for execution - -int iscsi_scsi_emu_primary_inquiry_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Fills in a single Vital Product Data (VPD) SCSI Port Designation Descriptor entry of an INQUIRY operation -int iscsi_scsi_emu_exec(iscsi_scsi_task *scsi_task); // Executes the iSCSI SCSI emulation for an iSCSI SCSI task - - -/// iSCSI port flags: In use. -#define ISCSI_PORT_FLAGS_IN_USE (1 << 0) - - -/** - * @brief iSCSI port. - * - * This structure maintains the transport ID, - * name, identifiers and index of an ISCSI - * port. - */ -typedef struct iscsi_port { - /// Transport ID. - iscsi_transport_id *transport_id; - - /// Name. - uint8_t *name; - - /// Identifier. - uint64_t id; - - /// Flags. - int flags; - - /// Index. - uint16_t index; - - /// Transport ID length. - uint16_t transport_id_len; -} iscsi_port; - - -iscsi_port *iscsi_port_create(const uint8_t *name, const uint64_t id, const uint16_t index); // Allocates and initializes an iSCSI port -int iscsi_port_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI port destructor callback for hash map -void iscsi_port_destroy(iscsi_port *port); // Deallocates all resource acquired iscsi_port_create - -uint8_t *iscsi_port_get_name(const iscsi_port *port); // Retrieves the name of an iSCSI port - -int iscsi_port_transport_id_set(iscsi_port *port, const uint8_t *name, const uint64_t isid); // Sets the SCSI transport ID of the iSCSI port - - -/// iSCSI SCSI LUN flags: Removed. -#define ISCSI_SCSI_LUN_FLAGS_REMOVED (1 << 0) - -/// iSCSI SCSI LUN flags: Resizing. -#define ISCSI_SCSI_LUN_FLAGS_RESIZING (1 << 1) - - -typedef struct iscsi_device iscsi_device; - - -/** - * @brief iSCSI SCSI LUN. - * - * This structure managesw the SCSI - * LUNs attached to an iSCSI device - * and associates a disk image file. - */ -typedef struct iscsi_scsi_lun { - /// Doubly linked list containing associated tasks with this LUN. - iscsi_list tasks; - - /// Mutex for accessing the associated tasks through multiple threads. - pthread_mutex_t tasks_mutex; - - /// Doubly linked list containing associated pending tasks with this LUN. - iscsi_list tasks_pending; - - /// Mutex for accessing the associated pending tasks through multiple threads. - pthread_mutex_t tasks_pending_mutex; - - /// Doubly linked list containing associated management tasks with this LUN. - iscsi_list tasks_mgmt; - - /// Mutex for accessing the associated management tasks through multiple threads. - pthread_mutex_t tasks_mgmt_mutex; - - /// Doubly linked list containing associated management pending tasks with this LUN. - iscsi_list tasks_mgmt_pending; - - /// Mutex for accessing the associated management pending tasks through multiple threads. - pthread_mutex_t tasks_mgmt_pending_mutex; - - /// Doubly linked list containg Persistent Reservation (PR) registrant for I_T nexus. - iscsi_hashmap *pr_regs; - - /// Persistent Reservation (PR) for the LUN. - iscsi_scsi_pr_reservation pr_reservation; - - /// Persistent Reservation (PR) holder for SPC2 RESERVE(6) and RESERVE(10). - iscsi_scsi_pr_registrant pr_scsi2_holder; - - /// iSCSI device which belongs to this LUN. - iscsi_device *device; - - /// Assocated DNBD3 image for this LUN. - dnbd3_image_t *image; - - /// LUN identifier (always MUST be between 0 and 7). - int id; - - /// Flags. - int flags; - - /// Persistent Reservation (PR) generation. - uint32_t pr_gen; -} iscsi_scsi_lun; - - -/// iSCSI device flags: Allocated. -#define ISCSI_DEVICE_FLAGS_ALLOCATED (1 << 0) - -/// iSCSI device flags: Removed. -#define ISCSI_DEVICE_FLAGS_REMOVED (1 << 1) - - -/** - * @brief iSCSI device. - * - * This structure managesw the SCSI - * devices and associates the - * disk image files with them. - */ -typedef struct iscsi_device { - /// Name of device. - uint8_t *name; - - /// LUNs associated with this device. - iscsi_hashmap *luns; - - /// Read/write lock for hash map containing all LUNs associated with this device. MUST be initialized with iscsi_create before any iSCSI functions are used. - pthread_rwlock_t luns_rwlock; - - /// Ports associated with this device. - iscsi_hashmap *ports; - - /// Device identifier. - int id; - - /// Flags. - int flags; - - /// Number of active connections for this device. - uint32_t active_conns; - - /// Protocol identifier. - uint8_t protocol_id; -} iscsi_device; - - -/// iSCSI target node maximum length. -#define ISCSI_TARGET_NODE_MAX_NAME_LEN 223U - - -/// iSCSI target node IQN identifier prefix string. -#define ISCSI_TARGET_NODE_NAME_IQN_PREFIX "iqn." - -/// iSCSI target node IEEE NAA identifier prefix string. -#define ISCSI_TARGET_NODE_NAME_NAA_PREFIX "naa." - -/// iSCSI target node EUI identifier prefix string. -#define ISCSI_TARGET_NODE_NAME_EUI_PREFIX "eui." - /// iSCSI target node WWN identifier prefix string. -#define ISCSI_TARGET_NODE_NAME_WWN_PREFIX "wwn-0x" +#define ISCSI_TARGET_NODE_WWN_NAME_PREFIX "wwn-0x" +/// iSCSI target node maximum length +#define ISCSI_TARGET_NODE_MAX_NAME_LEN 223U -/// iSCSI target node flags: CHAP authentication disabled. -#define ISCSI_TARGET_NODE_FLAGS_CHAP_DISABLE (1 << 0) - -/// iSCSI target node flags: CHAP authentication required. -#define ISCSI_TARGET_NODE_FLAGS_CHAP_REQUIRE (1 << 1) -/// iSCSI target node flags: CHAP authentication mutual. -#define ISCSI_TARGET_NODE_FLAGS_CHAP_MUTUAL (1 << 2) +/// iSCSI session type: Invalid. +#define ISCSI_SESSION_TYPE_INVALID 0 -/// iSCSI target node flags: Destroyed. -#define ISCSI_TARGET_NODE_FLAGS_DESTROYED (1 << 3) +/// iSCSI session type: Normal. +#define ISCSI_SESSION_TYPE_NORMAL 1 +/// iSCSI session type: Discovery. +#define ISCSI_SESSION_TYPE_DISCOVERY 2 /** - * @brief iSCSI target node. - * - * This structure maintains the name, alias, - * associated device and connection data - * for a specific iSCSI target node. + * All mandatory fields in login process. + * Set to -1 or NULL if not sent by client. */ -typedef struct iscsi_target_node { - /// Name of target node. - uint8_t *name; - - /// Alias name of target node. - uint8_t *alias; - - /// Associated iSCSI device. - iscsi_device *device; - - /// Target node number. - uint num; - - /// Queue depth. - uint queue_depth; - - /// Flags. - int flags; - - /// Header digest size (always MUST be 0 or 4 for now). - int header_digest; - - /// Data digest size (always MUST be 0 or 4 for now). - int data_digest; +typedef struct iscsi_login_kvp +{ + /// Largest PDU client can receive. + int MaxRecvDataSegmentLength; - /// CHAP group ID. - int32_t chap_group; + /// Maximum burst length client can receive. + int MaxBurstLength; - /// Number of active connections for this target node. - uint32_t active_conns; -} iscsi_target_node; + // Maximum unsolicited burst length client can receive. + int FirstBurstLength; + /// Maximum number of connections. + int MaxConnections; -/** - * @brief iSCSI target node search by name. - * - * This structure is used by iterating through - * all iSCSI target nodes finding by name. - */ -typedef struct iscsi_target_node_find_name { - /// Found iSCSI target node is stored here, should be initialized to NULL. - iscsi_target_node *target; + /// Error recovery level. + int ErrorRecoveryLevel; - /// The name of the target node to search for. - uint8_t *name; -} iscsi_target_node_find_name; + /// The session type (Discovery, Normal). + const char *SessionType; + /// Desired auth method. + const char *AuthMethod; -/// iSCSI authentication CHAP phase: None. -#define ISCSI_AUTH_CHAP_PHASE_NONE 0 + /// SendTargets command. + const char *SendTargets; -/// iSCSI authentication CHAP phase: Wait A. -#define ISCSI_AUTH_CHAP_PHASE_WAIT_A 1 + /// HeaderDigest requested by client. + const char *HeaderDigest; -/// iSCSI authentication CHAP phase: Wait NR. -#define ISCSI_AUTH_CHAP_PHASE_WAIT_NR 2 + /// DataDigest requested by client. + const char *DataDigest; -/// iSCSI authentication CHAP phase: End. -#define ISCSI_AUTH_CHAP_PHASE_END 3 + const char *InitiatorName; + const char *TargetName; +} iscsi_negotiation_kvp; /** - * @brief iSCSI CHAP authentication data structure. - * - * This structure maintains all data required for - * CHAP authentication method. + * Options/limits the client told us that + * are relevant for proper communication */ -typedef struct iscsi_auth_chap { - /// CHAP phase. - int phase; -} iscsi_auth_chap; - - -/// iSCSI session flags: Initial ready to transfer. -#define ISCSI_SESSION_FLAGS_INIT_R2T (1 << 0) - -/// iSCSI session flags: Immediate data. -#define ISCSI_SESSION_FLAGS_IMMEDIATE_DATA (1 << 1) - -/// iSCSI session flags: Data PDU in order. -#define ISCSI_SESSION_FLAGS_DATA_PDU_IN_ORDER (1 << 2) - -/// iSCSI session flags: Data sequence in order. -#define ISCSI_SESSION_FLAGS_DATA_SEQ_IN_ORDER (1 << 3) - - -/// iSCSI session type: Invalid. -#define ISCSI_SESSION_TYPE_INVALID 0 - -/// iSCSI session type: Normal. -#define ISCSI_SESSION_TYPE_NORMAL 1 +typedef struct iscsi_session_options +{ + /// Largest PDU client can receive. + int MaxRecvDataSegmentLength; -/// iSCSI session type: Discovery. -#define ISCSI_SESSION_TYPE_DISCOVERY 2 + /// Maximum burst length client can receive. + int MaxBurstLength; + // Maximum unsolicited burst length client can receive. + int FirstBurstLength; +} iscsi_session_options; /** * @brief iSCSI session. @@ -11245,68 +6043,29 @@ typedef struct iscsi_auth_chap { * login phase. */ typedef struct iscsi_session { - /// List of iSCSI connections associated with this session. - iscsi_list conn_list; - - /// Initiator port. - iscsi_port *init_port; - - /// Hash map of login key / value pairs negotiated with this session. - iscsi_hashmap *key_value_pairs; - - /// iSCSI target node. - iscsi_target_node *target; - - /// Portal group tag. - uint64_t tag; - - /// Initiator Session ID (ISID). - uint64_t isid; + /// Initiator Session ID (ISID). + uint64_t isid; - /// Target Session Identifying Handle (TSIH). - uint64_t tsih; + /// Target Session Identifying Handle (TSIH). + uint64_t tsih; - /// Flags (extracted from key and value pairs). - int flags; + /// Flags (extracted from key and value pairs). + int flags; - /// Queue depth. - uint queue_depth; + /// iSCSI session type. + int type; - /// iSCSI session type. - int type; + /// ExpCmdSN. + uint32_t exp_cmd_sn; - /// Number of active connections linked to this session. - uint32_t conns; + /// MaxCmdSN. + uint32_t max_cmd_sn; - /// Maximum number of connections. - uint32_t max_conns; + /// Current text Initiator Task Tag (ITT). + uint32_t current_text_init_task_tag; - /// Ready to transfer maximum outstanding value. - uint32_t max_outstanding_r2t; - - /// Default time to wait. - uint32_t default_time_to_wait; - - /// Default time to retain. - uint32_t default_time_to_retain; - - /// First burst length. - uint32_t first_burst_len; - - /// Maximum burst length. - uint32_t max_burst_len; - - /// Error recovery level. - uint32_t err_recovery_level; - - /// ExpCmdSN. - uint32_t exp_cmd_sn; - - /// MaxCmdSN. - uint32_t max_cmd_sn; - - /// Current text Initiator Task Tag (ITT). - uint32_t current_text_init_task_tag; + /// Session options client sent in login request. + iscsi_session_options opts; } iscsi_session; @@ -11320,16 +6079,16 @@ typedef struct iscsi_pdu iscsi_pdu; #define ISCSI_CONNECT_PDU_READ_PROCESSED 1 /// iSCSI connection read packet data return code from iscsi_connection_pdu_read function: Fatail error during packet parsing. -#define ISCSI_CONNECT_PDU_READ_ERR_FATAL -1 +#define ISCSI_CONNECT_PDU_READ_ERR_FATAL (-1) /// iSCSI connection read packet data return code from iscsi_connection_pdu_read function: Login error response. -#define ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE -2 +#define ISCSI_CONNECT_PDU_READ_ERR_LOGIN_RESPONSE (-2) /// iSCSI connection read packet data return code from iscsi_connection_pdu_read function: Login parameter error. -#define ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER -3 +#define ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER (-3) /// iSCSI connection read packet data return code from iscsi_connection_pdu_read function: Login parameter not exchanged once error. -#define ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER_XCHG_NOT_ONCE -4 +#define ISCSI_CONNECT_PDU_READ_ERR_LOGIN_PARAMETER_XCHG_NOT_ONCE (-4) /// iSCSI connection flags: Stopped. @@ -11399,258 +6158,59 @@ typedef struct iscsi_pdu iscsi_pdu; * and iSCSI portals. */ typedef struct iscsi_connection { - /// Doubly linked list node, MUST be first element. - iscsi_node node; - - /// iSCSI session associated with this connection. - iscsi_session *session; + /// iSCSI session associated with this connection. + iscsi_session *session; - /// Hash map containing login text key / value pairs associated to this connection. - iscsi_hashmap *key_value_pairs; + /// Associated dnbd3 client + dnbd3_client_t *client; - /// Temporarily storage for partially received login parameter. - uint8_t *partial_pairs; + /// Current PDU being processed. + iscsi_pdu *pdu_processing; - /// Hash map containing text key / value pairs associated to this connection. - iscsi_hashmap *text_key_value_pairs; + /// Login response PDU. + iscsi_pdu *login_response_pdu; - /// Temporarily storage for partially received text parameter. - uint8_t *text_partial_pairs; + /// Internal connection identifier + int id; - /// iSCSI device. - iscsi_device *device; + /// iSCSI connection receiving state. + int pdu_recv_state; - /// iSCSI initiator port. - iscsi_port *init_port; + /// iSCSI connection flags. + int flags; - /// Initiator name. - uint8_t *init_name; + /// iSCSI connection state. + int state; - //// Initiator IP address. - uint8_t *init_adr; + /// iSCSI connection login phase. + int login_phase; - /// iSCSI target node. - iscsi_target_node *target; + /// Initiator Session ID (ISID). + iscsi_isid isid; - /// iSCSI target port. - iscsi_port *target_port; + /// Target Session Identifying Handle (TSIH). + uint16_t tsih; - /// iSCSI target short name. - uint8_t *target_name_short; + /// Connection ID (CID). + uint16_t cid; - /// iSCSI portal host name. - uint8_t *portal_host; + /// Bit mask for connection state key negotiation. + uint16_t state_negotiated; - /// iSCSI portal host port. - uint8_t *portal_port; + /// Bit mask for session state key negotiation. + uint32_t session_state_negotiated; - /// Current PDU being processed. - iscsi_pdu *pdu_processing; + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; - /// Login response PDU. - iscsi_pdu *login_response_pdu; + /// Targer Transfer Tag (TTT). + uint32_t target_xfer_tag; - /// Doubly linked list containing enqueued SCSI Data In tasks. - iscsi_list scsi_data_in_queued_tasks; - - /// Doubly linked list containing writing PDU's associated with this connection. - iscsi_list pdus_write; - - /// Doubly linked list containing SNACK PDU's associated with this connection. - iscsi_list pdus_snack; - - /// Doubly linked list containing active Ready To Transfer (R2T) tasks. - iscsi_list r2t_tasks_active; - - /// Doubly linked list containing queued Ready To Transfer (R2T) tasks. - iscsi_list r2t_tasks_queue; - - /// iSCSI SendTargets total number of bytes completed. - uint target_send_total_size; - - /// iSCSI SCSI Data In count. - uint scsi_data_in_cnt; - - /// iSCSI SCSI Data Out count. - uint scsi_data_out_cnt; - - /// iSCSI tasks pending count. - uint task_cnt; - - /// Pending Ready To Transfer (R2T) tasks. - uint r2t_pending; - - /// iSCSI connection contains a header digest (CRC32), always MUST be 0 or 4 for now. - int header_digest; - - /// iSCSI connection contains a data digest (CRC32), always MUST be 0 or 4 for now. - int data_digest; - - /// Internal connection identifier (key of iSCSI global vector hash map). - int id; - - /// Connected TCP/IP socket. - int sock; - - /// iSCSI connection receiving state. - int pdu_recv_state; - - /// iSCSI connection flags. - int flags; - - /// iSCSI connection state. - int state; - - /// iSCSI connection login phase. - int login_phase; - - /// Maximum receive DataSegment length in bytes. - uint32_t max_recv_ds_len; - - /// Portal group tag. - uint64_t pg_tag; - - /// Initiator Session ID (ISID). - iscsi_isid isid; - - /// Target Session Identifying Handle (TSIH). - uint16_t tsih; - - /// Connection ID (CID). - uint16_t cid; - - /// Bit mask for connection state key negotiation. - uint16_t state_negotiated; - - /// Bit mask for session state key negotiation. - uint32_t session_state_negotiated; - - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /// Targer Transfer Tag (TTT). - uint32_t target_xfer_tag; - - /// CHAP authentication. - iscsi_auth_chap auth_chap; - - /// CHAP group id. - int32_t chap_group; - - /// StatSN. - uint32_t stat_sn; - - /// ExpStatSN. - uint32_t exp_stat_sn; - - /// Execution queue to run to invoke callback functions after asynchronous I/O has been finished. - iscsi_list exec_queue; - - // TODO: Remove after test finish - iscsi_hashmap *stat_iscsi_opcodes; - - // TODO: Remove after test finish - iscsi_hashmap *stat_scsi_opcodes; + /// StatSN. + uint32_t stat_sn; } iscsi_connection; -/** - * @brief iSCSI transfer completed callback function. - * - * This function is invoked when the response PDU - * write to the TCP/IP socket has been completed. - * - * @param[in] user_data Pointer to user data. - */ -typedef void (*iscsi_connection_xfer_complete_callback)(uint8_t *user_data); - - -/** - * @brief Callback for iSCSI connection write TCP/IP write operation completion. - * - * This function is invoked when the sending - * TCP/IP transfer has been finished. - * - * @param[in] user_data Pointer to user data. - * @param[in] err 0 if I/O completed successfully or an - * error code indicating the problem. - */ -typedef void (*iscsi_connection_write_complete_callback)(uint8_t *user_data, int err); - - -/// iSCSI connection asynchronous execution queue: SCSI emulation I/O. -#define ISCSI_CONNECT_EXEC_QUEUE_TYPE_SCSI_EMU_IO 0U - -/// iSCSI connection asynchronous execution queue: PDU write I/O. -#define ISCSI_CONNECT_EXEC_QUEUE_TYPE_PDU_WRITE 1U - - -/** - * @brief iSCSI connection execution queue. - * - * This structure is used for invoking the - * callback functions after processing has - * been completed.\n - * Currently, PDU writes and SCSI emulation - * invoke I/O callbacks after finishing - * their operations. - */ -typedef struct iscsi_connection_exec_queue { - /// Doubly linked list node, MUST be first element. - iscsi_node node; - - /** - * @union data - * @brief Invokes callback functions with arguments based on the execution queue type. - * - * This union contains the arguments needed - * for their respective callback functions - * of the completion process. - */ - union { - /** - * @brief PDU write completion callback and arguments. - * - * For PDU write completion type, two arguments - * are passed. - */ - struct { - /// Callback function to invoke after PDU write completion process has been completed. - iscsi_connection_write_complete_callback callback; - - /// User data to be passed to the PDU write completion process callback function. - uint8_t *user_data; - - /// Error code to be passed to the PDU write completion process callback function. - int err; - } pdu_write; - - /** - * @brief I/O completion callback and arguments. - * - * For I/O completion type, three arguments - * are passed. - */ - struct { - /// Callback function to invoke after I/O process has been completed. - iscsi_scsi_emu_io_complete_callback callback; - - /// DNBD3 image to be passed to the I/O completion process callback function. - dnbd3_image_t *image; - - /// User data to be passed to the I/O completion process callback function. - uint8_t *user_data; - - /// Successful state passed to the I/O completion process callback function. - bool success; - } io; - } data; - - /// Type of completion callback. - uint type; -} iscsi_connection_exec_queue; - - typedef struct iscsi_task iscsi_task; @@ -11666,77 +6226,38 @@ typedef struct iscsi_task iscsi_task; * and filling the BHS, AHS and DS properly. */ typedef struct iscsi_pdu { - /// Doubly linked list node, MUST be first element. - iscsi_node node; - - /// iSCSI Basic Header Segment (BHS) packet data. - iscsi_bhs_packet *bhs_pkt; - - /// iSCSI Advanced Header Segment (AHS) packet data for fast access and is straight after BHS packet in memory. - iscsi_ahs_packet *ahs_pkt; - - /// Header digest (CRC32C) packet data for fast access and is straight after BHS and AHS packet in memory. - iscsi_header_digest *header_digest; - - /// iSCSI DataSegment (DS) packet data for fast access and is straight after BHS, AHS and header digest packet in memory. - iscsi_scsi_ds_cmd_data *ds_cmd_data; - - /// Data digest (CRC32C) packet data for fast access and is straight after BHS, AHS, header digest and DataSegment packet in memory. - iscsi_data_digest *data_digest; - - /// iSCSI task handling this PDU. - iscsi_task *task; - - /// Associated iSCSI connection. - iscsi_connection *conn; - - /// Transfer complete callback function. - iscsi_connection_xfer_complete_callback xfer_complete_callback; - - /// Transfer complete callback user data (arguments). - uint8_t *xfer_complete_user_data; - - /// Flags. - int flags; - - /// Reference counter. - uint32_t ref; - - /// Bytes of Basic Header Segment (BHS) already read. - uint bhs_pos; - - /// Bytes of Advanced Header Segment (AHS) already read. - uint ahs_pos; + /// iSCSI Basic Header Segment (BHS) packet data. + iscsi_bhs_packet *bhs_pkt; - /// AHSLength. - uint ahs_len; + /// iSCSI Advanced Header Segment (AHS) packet data for fast access and is straight after BHS packet in memory. + iscsi_ahs_packet *ahs_pkt; - /// Bytes of header digest (CRC32C) already read. - uint header_digest_pos; + /// iSCSI DataSegment (DS) packet data for fast access and is straight after BHS, AHS and header digest packet in memory. + iscsi_scsi_ds_cmd_data *ds_cmd_data; - /// Header digest size (always 0 or 4 for now). - int header_digest_size; + /// iSCSI task handling this PDU. + iscsi_task *task; - /// DataSegmentLength. - uint32_t ds_len; + /// Flags. + int flags; - /// Position of DataSegment buffer for next operation. - uint32_t pos; + /// Bytes of Basic Header Segment (BHS) already read. + uint bhs_pos; - /// Allocated DataSegment buffer length. - uint32_t len; + /// AHSLength. + uint ahs_len; - /// Bytes of data digest (CRC32C) already read. - uint data_digest_pos; + /// DataSegmentLength. + uint32_t ds_len; - /// Data digest size (always 0 or 4 for now). - int data_digest_size; + /// DS Buffer write pos when filling buffer for sending. + uint32_t ds_write_pos; - /// Tasks referenced by this PDU counter. - uint task_ref_cnt; + /// Read position in AHS + DS buffer (recv). + uint32_t recv_pos; - /// CmdSN. - uint32_t cmd_sn; + /// CmdSN. + uint32_t cmd_sn; } iscsi_pdu; @@ -11754,163 +6275,43 @@ typedef struct iscsi_pdu { * including the underlying SCSI layer. */ typedef struct iscsi_task { - /// Doubly linked list node, MUST be first element. - iscsi_node node; + /// Underlying SCSI task structure. + iscsi_scsi_task scsi_task; - /// Underlying SCSI task structure. - iscsi_scsi_task scsi_task; + /// Associated iSCSI connection. + iscsi_connection *conn; - /// Parent iSCSI task. - iscsi_task *parent; + /// Buffer position in bytes. + uint32_t pos; - /// Sub tasks doubly linked list for splitted data transfers. - iscsi_list sub_tasks; + /// Buffer length in bytes. + uint32_t len; - /// Associated iSCSI connection. - iscsi_connection *conn; + /// Unique identifier for this task. + uint64_t id; - /// Associated iSCSI PDU. - iscsi_pdu *pdu; + /// Flags. + int flags; - /// Buffer position in bytes. - uint32_t pos; + /// LUN identifier associated with this task (always MUST be between 0 and 7), used for hot removal tracking. + int lun_id; - /// Buffer length in bytes. - uint32_t len; + /// Initiator Task Tag (ITT). + uint32_t init_task_tag; - /// Unique identifier for this task. - uint64_t id; + /// Target Transfer Tag (TTT). + uint32_t target_xfer_tag; - /// Flags. - int flags; + /// Desired number of bytes completed. + uint32_t des_data_xfer_pos; - /// LUN identifier associated with this task (always MUST be between 0 and 7), used for hot removal tracking. - int lun_id; + /// Desired data transfer length. + uint32_t des_data_xfer_len; - /// Initiator Task Tag (ITT). - uint32_t init_task_tag; - - /// Target Transfer Tag (TTT). - uint32_t target_xfer_tag; - - /// Desired number of bytes completed. - uint32_t des_data_xfer_pos; - - /// Desired data transfer length. - uint32_t des_data_xfer_len; - - /// SCSI Data In Data Sequence Number (DataSN). - uint32_t data_sn; - - /// SCSI Data Out count. - uint32_t scsi_data_out_cnt; - - /// Length in bytes of R2T, used for ensuring that R2T burst does not exceed MaxBurstLength. - uint32_t r2t_len; - - /// Ready To Transfer Sequence Number (R2TSN). - uint32_t r2t_sn; - - /// Next expected Ready To Transfer offset is used for receiving the Data-OUT PDU. - uint32_t r2t_next_exp_pos; - - /// Ready To Transfer DataSN, used for next sequence of a R2TSN. - uint32_t r2t_data_sn; - - /// Next R2TSN to be acknowledged. - uint32_t r2t_sn_ack; - - /// Outstanding Ready To Transfer (R2T) count. - uint32_t r2t_outstanding; + /// SCSI Data In Data Sequence Number (DataSN). + uint32_t data_sn; } iscsi_task; - -iscsi_task *iscsi_task_create(iscsi_connection *conn, iscsi_task *parent, iscsi_scsi_task_xfer_complete_callback callback); // Allocates and initializes an iSCSI task structure -void iscsi_task_destroy_callback(iscsi_scsi_task *scsi_task); // Deallocates all resources of the iSCSI task of an iSCSI SCSI task -void iscsi_task_destroy(iscsi_task *task); // Deallocates resources acquired by iscsi_task_create - -void iscsi_task_queue(iscsi_connection *conn, iscsi_task *task); // Enqueues an iSCSI task - -void iscsi_task_xfer_complete_process_read(iscsi_connection *conn, iscsi_task *task, iscsi_task *primary_task); // Processes an iSCSI SCSI task which completed a read data transfer -bool iscsi_task_xfer_del(iscsi_connection *conn, const uint32_t target_xfer_tag); // Deletes an iSCSI task from the active Ready To Transfer (R2T) doubly linked list by Target Transfer Tag (TTT) -void iscsi_task_xfer_complete_process_other(iscsi_connection *conn, iscsi_task *task, iscsi_task *primary_task); // Processes an iSCSI SCSI task which completed a non-read data transfer - -void iscsi_task_response(iscsi_connection *conn, iscsi_task *task); // Creates, initializes and sends an iSCSI task reponse PDU. - -iscsi_device *iscsi_device_create(const uint8_t *name, const int lun_id, const uint8_t protocol_id); // Creates and initializes an iSCSI device with a maximum number of LUNs -int iscsi_device_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI device destructor callback for hash map -void iscsi_device_destroy(iscsi_device *device); // Deallocates all resources acquired by iscsi_device_create - -iscsi_port *iscsi_device_find_port_by_portal_group_tag(const iscsi_device *device, const uint64_t id); // Gets an iSCSI device being in use by portal group identifier -iscsi_scsi_lun *iscsi_device_find_lun(iscsi_device *device, const int lun_id); // Searches an iSCSI LUN by LUN identifier - -int iscsi_device_port_add(iscsi_device *device, const uint8_t *name, const uint64_t id); // Creates, initializes and adds an iSCSI target port to an iSCSI device - -void iscsi_device_scsi_task_queue(iscsi_device *device, iscsi_scsi_task *scsi_task); // Enqueues an iSCSI SCSI task to the first LUN of an iSCSI device - -int iscsi_target_node_create_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Creates, initializes and adds a portal group to an iSCSI target node -iscsi_target_node *iscsi_target_node_create(uint8_t *name, const uint8_t *alias, const int index, const int lun_id, const uint queue_depth, const int flags, const int32_t chap_group, const int header_digest, const int data_digest); // Creates and initializes an iSCSI target node -int iscsi_target_node_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI target node destructor callback for hash map -void iscsi_target_node_destroy(iscsi_target_node *target); // Deallocates all resources acquired by iscsi_target_node_create - -int32_t iscsi_target_node_send(iscsi_connection *conn, const uint8_t *dst_iqn, const uint8_t *src_iqn, uint8_t *buf, const uint32_t pos, const uint32_t len); // Sends a buffer from a source iSCSI IQN to target iSCSI IQNs -uint64_t iscsi_target_node_wwn_get(const uint8_t *name); // Calculates the WWN using 64-bit IEEE Extended NAA for a name -dnbd3_image_t *iscsi_target_node_image_get(uint8_t *iqn); // Extracts the DNBD3 image out of an iSCSI IQN string and opens the DNBD3 image -int iscsi_target_node_find_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // Finds an iSCSI target node by case insensitive name search -iscsi_target_node *iscsi_target_node_find(uint8_t *target_name); // Searches an iSCSI target node by name using case insensitive search - -uint8_t *iscsi_target_node_get_redirect(iscsi_connection *conn, iscsi_target_node *target); // Retrieves target node redirection address -int iscsi_target_node_access(iscsi_connection *conn, iscsi_target_node *target, const uint8_t *iqn, const uint8_t *adr); // Checks if target node is accessible - -iscsi_session *iscsi_session_create(iscsi_connection *conn, iscsi_target_node *target, const int type); // Creates and initializes an iSCSI session -int iscsi_session_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI session destructor callback for hash map -void iscsi_session_destroy(iscsi_session *session); // Deallocates all resources acquired by iscsi_session_create - -int iscsi_session_init_key_value_pairs(iscsi_hashmap *key_value_pairs); // Initializes a key and value pair hash table with default values - -iscsi_connection *iscsi_connection_create(iscsi_portal *portal, const int sock); // Creates data structure for an iSCSI connection from iSCSI portal and TCP/IP socket -int iscsi_connection_destroy_callback(uint8_t *key, const size_t key_size, uint8_t *value, uint8_t *user_data); // iSCSI connection destructor callback for hash map -void iscsi_connection_destroy(iscsi_connection *conn); // Deallocates all resources acquired by iscsi_connection_create - -int iscsi_connection_drop(iscsi_connection *conn, const uint8_t *conn_match, const int all); // Drops all connections based on matching pattern -void iscsi_connection_schedule(iscsi_connection *conn); // Schedules an iSCSI connection - -int32_t iscsi_connection_read(const iscsi_connection *conn, uint8_t *buf, const uint32_t len); // Reads data for the specified iSCSI connection from its TCP socket -int32_t iscsi_connection_write(const iscsi_connection *conn, uint8_t *buf, const uint32_t len); // Writes data for the specified iSCSI connection to its TCP socket -int iscsi_connection_handle_scsi_data_in_queued_tasks(iscsi_connection *conn); // This function handles all queued iSCSI SCSI Data In tasks - -int iscsi_connection_init_key_value_pairs(iscsi_hashmap *key_value_pairs); // Initializes a key and value pair hash table with default values for an iSCSI connection -int32_t iscsi_negotiate_key_value_pairs(iscsi_connection *conn, iscsi_hashmap *key_value_pairs, uint8_t *buf, const uint32_t pos, const uint32_t len); // Negotiates all key and value pairs required for session authentication -int iscsi_connection_copy_key_value_pairs(iscsi_connection *conn); // Copies retrieved key and value pairs into SCSI connection and session structures -int iscsi_connection_save_incoming_key_value_pairs(iscsi_connection *conn, iscsi_hashmap *key_value_pairs, iscsi_pdu *login_response_pdu, const iscsi_pdu *pdu); // Saves incoming key / value pairs from the client of a login request PDU -void iscsi_connection_login_response_reject(iscsi_pdu *login_response_pdu, const iscsi_pdu *pdu); // Initializes a rejecting login response packet -iscsi_pdu *iscsi_connection_pdu_create(iscsi_connection *conn, const uint ahs_len, const int header_digest_size, const uint32_t ds_len, const int data_sigest_size ); // Creates an iSCSI PDU structure used by connections -void iscsi_connection_pdu_destroy(iscsi_pdu *pdu); // Destroys an iSCSI PDU structure used by connections -void iscsi_connection_pdu_free(iscsi_connection *conn, iscsi_pdu *pdu); // Frees an iSCSI PDU structure used by using connection callback function - -iscsi_bhs_packet *iscsi_connection_pdu_append(iscsi_pdu *pdu, const uint ahs_len, const int header_digest_size, const uint32_t ds_len, const int data_digest_size); // Appends packet data to an iSCSI PDU structure used by connections -iscsi_ahs_packet *iscsi_connection_pdu_ahs_packet_get(const iscsi_pdu *pdu, const int index); // Retrieves the pointer to an specific AHS packet from an iSCSI PDU by index -int iscsi_connection_pdu_ahs_packet_count(const iscsi_pdu *pdu); // Counts number of AHS packets of an iSCSI PDU - -void iscsi_connection_pdu_digest_header_update(iscsi_header_digest *header_digest, const iscsi_bhs_packet *packet_data, const uint ahs_len); // Calculate and store iSCSI header digest (CRC32C) -bool iscsi_connection_pdu_digest_header_verify(const iscsi_header_digest *header_digest, const iscsi_bhs_packet *packet_data, const uint ahs_len); // Validates a stored iSCSI header digest (CRC32C) with actual header data -void iscsi_connection_pdu_digest_data_update(iscsi_data_digest *data_digest, const iscsi_scsi_ds_cmd_data *ds_cmd_data, const uint32_t ds_len); // Calculate iSCSI data digest (CRC32C) -bool iscsi_connection_pdu_digest_data_verify(const iscsi_data_digest *data_digest, const iscsi_scsi_ds_cmd_data *ds_cmd_data, const uint32_t ds_len); // Validates a stored iSCSI data digest (CRC32C) with actual DataSegment - -void iscsi_connection_pdu_ack_remove(iscsi_connection *conn, const uint32_t exp_stat_sn); // Removes an acknowledged PDU from SNACK PDU doubly linked list by ExpStatSN - -iscsi_pdu *iscsi_r2t_find_pdu_bhs(iscsi_connection *conn, iscsi_pdu *pdu); // Searches an iSCSI PDU by Basic Header Segment (BHS) in the Ready To Transfer (R2T) active and queued task doubly linked list -int iscsi_r2t_send(iscsi_connection *conn, iscsi_task *task, uint32_t *r2t_sn, const uint32_t pos, const uint32_t len, const uint32_t target_xfer_tag); // Sends an iSCSI Ready To Transfer Sequence Number (R2TSN) packet to the initiator - -int iscsi_connection_read_data(iscsi_connection *conn, int len, void *buf); -int iscsi_connection_read_iov_data(iscsi_connection *conn, struct iovec *iov, int iov_count); -void iscsi_connection_pdu_write(iscsi_connection *conn, iscsi_pdu *pdu, iscsi_connection_xfer_complete_callback callback, uint8_t *user_data); - -int iscsi_connection_pdu_handle(iscsi_connection *conn); // Handles incoming PDU data, read up to 16 fragments at once void iscsi_connection_handle(dnbd3_client_t *client, const dnbd3_request_t *request, const int len); // Handles an iSCSI connection until connection is closed -#ifdef __cplusplus -} -#endif - #endif /* DNBD3_ISCSI_H_ */ diff --git a/src/server/net.c b/src/server/net.c index a279b02..48890df 100644 --- a/src/server/net.c +++ b/src/server/net.c @@ -33,6 +33,7 @@ #include <dnbd3/shared/serialize.h> #include <assert.h> +#include <netinet/tcp.h> #ifdef __linux__ #include <sys/sendfile.h> @@ -152,14 +153,43 @@ void net_init() mutex_init( &_clients_lock, LOCK_CLIENT_LIST ); } +void initClientStruct(dnbd3_client_t *client) +{ + mutex_init( &client->lock, LOCK_CLIENT ); + mutex_init( &client->sendMutex, LOCK_CLIENT_SEND ); + + mutex_lock( &client->lock ); + host_to_string( &client->host, client->hostName, HOSTNAMELEN ); + client->hostName[HOSTNAMELEN-1] = '\0'; + mutex_unlock( &client->lock ); + client->bytesSent = 0; + client->relayedCount = 0; +} + void* net_handleNewConnection(void *clientPtr) { dnbd3_client_t * const client = (dnbd3_client_t *)clientPtr; dnbd3_request_t request; + dnbd3_cache_map_t *cache = NULL; client->thread = pthread_self(); // Await data from client. Since this is a fresh connection, we expect data right away sock_setTimeout( client->sock, _clientTimeout ); + // NODELAY makes sense since we're sending a lot of data + int e2 = 1; + socklen_t optlen = sizeof(e2); + setsockopt( client->sock, IPPROTO_TCP, TCP_NODELAY, (void *)&e2, optlen ); + // Also increase send buffer + if ( getsockopt( client->sock, SOL_SOCKET, SO_SNDBUF, (void *)&e2, &optlen ) == 0 ) { +#ifdef __linux__ + // Linux doubles the value to account for overhead, get "real" value + e2 /= 2; +#endif + if ( e2 < SERVER_TCP_BUFFER_MIN_SIZE_PAYLOAD ) { + e2 = SERVER_TCP_BUFFER_MIN_SIZE_PAYLOAD; + setsockopt( client->sock, SOL_SOCKET, SO_SNDBUF, &e2, sizeof(e2) ); + } + } do { #ifdef DNBD3_SERVER_AFL const int ret = (int)recv( 0, &request, sizeof(request), MSG_WAITALL ); @@ -178,8 +208,16 @@ void* net_handleNewConnection(void *clientPtr) if ( ((char*)&request)[0] == 'G' || ((char*)&request)[0] == 'P' ) { // Close enough... rpc_sendStatsJson( client->sock, &client->host, &request, ret ); + } else if ( true /* check opcode ... */ ) { + initClientStruct( client ); + if ( !addToList( client ) ) { + freeClientStruct( client ); + logadd( LOG_WARNING, "Could not add new iSCSI client to list when connecting" ); + } else { + iscsi_connection_handle( client, &request, ret ); + goto exit_client_cleanup; + } } else { - iscsi_connection_handle( client, &request, ret ); logadd( LOG_DEBUG1, "Magic in client handshake incorrect" ); } goto fail_preadd; @@ -192,26 +230,17 @@ void* net_handleNewConnection(void *clientPtr) } } while (0); // Fully init client struct - mutex_init( &client->lock, LOCK_CLIENT ); - mutex_init( &client->sendMutex, LOCK_CLIENT_SEND ); - - mutex_lock( &client->lock ); - host_to_string( &client->host, client->hostName, HOSTNAMELEN ); - client->hostName[HOSTNAMELEN-1] = '\0'; - mutex_unlock( &client->lock ); - client->bytesSent = 0; - client->relayedCount = 0; + initClientStruct( client ); if ( !addToList( client ) ) { freeClientStruct( client ); - logadd( LOG_WARNING, "Could not add new client to list when connecting" ); - return NULL; + logadd( LOG_WARNING, "Could not add new DNBD3 client to list when connecting" ); + goto fail_preadd; } dnbd3_reply_t reply; dnbd3_image_t *image = NULL; - dnbd3_cache_map_t *cache = NULL; int image_file = -1; int num; @@ -518,11 +547,11 @@ exit_client_cleanup: ; removeFromList( client ); totalBytesSent += client->bytesSent; // Access time, but only if client didn't just probe - if ( image != NULL && client->bytesSent > DNBD3_BLOCK_SIZE * 10 ) { - mutex_lock( &image->lock ); - timing_get( &image->atime ); - image->accessed = true; - mutex_unlock( &image->lock ); + if ( client->image != NULL && client->bytesSent > DNBD3_BLOCK_SIZE * 10 ) { + mutex_lock( &client->image->lock ); + timing_get( &client->image->atime ); + client->image->accessed = true; + mutex_unlock( &client->image->lock ); } if ( cache != NULL ) { ref_put( &cache->reference ); @@ -688,7 +717,7 @@ static dnbd3_client_t* freeClientStruct(dnbd3_client_t *client) dnbd3_uplink_t *uplink = ref_get_uplink( &client->image->uplinkref ); if ( uplink != NULL ) { if ( client->relayedCount != 0 ) { - uplink_removeEntry( uplink, client, &uplinkCallback ); + uplink_removeEntry( uplink, client ); } ref_put( &uplink->reference ); } diff --git a/src/server/sendfile.c b/src/server/sendfile.c new file mode 100644 index 0000000..9e27238 --- /dev/null +++ b/src/server/sendfile.c @@ -0,0 +1,60 @@ +#include "sendfile.h" + +#if defined(__linux__) +#include <sys/sendfile.h> +#elif defined(__FreeBSD__) +#include <sys/types.h> +#include <sys/socket.h> +#include <sys/uio.h> +#else +#error "What platform is this?" +#endif + +#include <errno.h> + +bool sendfile_all(const int fd, const int sock, off_t foffset, const size_t bytes) +{ + if ( bytes == 0 ) + return true; +#ifdef DNBD3_SERVER_AFL + errno = 0; + return true; +#elif defined(__linux__) + size_t done = 0; + int againCount = 0; + + while ( done < bytes ) { + const ssize_t sent = sendfile( sock, fd, &foffset, bytes - done ); + if ( sent == 0 ) // Probably EOF, like with send(), but manpage is not clear :-/ + return false; + if ( sent < 0 ) { + if ( errno == EAGAIN || errno == EINTR ) { + // Retry once, but give up otherwise - EAGAIN might just be the send timeout + if ( ++againCount > 1 ) + return false; + continue; + } + return false; + } + done += sent; + } +#elif defined(__FreeBSD__) + off_t sent; + size_t done = 0; + int againCount = 0; + + while ( done < bytes ) { + const int ret = sendfile( fd, sock, foffset + done, bytes - done, NULL, &sent, 0 ); + if ( ret == 0 || errno == EAGAIN || errno == EINTR ) { + // Retry once, but give up otherwise - EAGAIN might just be the send timeout + if ( sent == 0 && ++againCount > 1 ) + return false; + done += sent; + continue; + } + // Something else went wrong + return false; + } +#endif + return true; +}
\ No newline at end of file diff --git a/src/server/sendfile.h b/src/server/sendfile.h new file mode 100644 index 0000000..e4cc5b7 --- /dev/null +++ b/src/server/sendfile.h @@ -0,0 +1,18 @@ +#ifndef SENDFILE_H_ +#define SENDFILE_H_ + +#include <stdbool.h> +#include <stddef.h> +#include <sys/types.h> + +/** + * Platform-agnostic wrapper around sendfile, with retry logic. + * @param fd file to read from + * @param sock socket to write to + * @param foffset offset in file to start reading from + * @param bytes number of bytes to read/send + * @return true on success + */ +bool sendfile_all(int fd, int sock, off_t foffset, size_t bytes); + +#endif
\ No newline at end of file diff --git a/src/server/server.c b/src/server/server.c index 0bbb417..b91e4ce 100644 --- a/src/server/server.c +++ b/src/server/server.c @@ -27,7 +27,6 @@ #include "net.h" #include "altservers.h" #include "integrity.h" -#include "iscsi.h" #include "threadpool.h" #include "rpc.h" #include "fuse.h" @@ -177,10 +176,6 @@ _Noreturn static void dnbd3_cleanup() threadpool_waitEmpty(); - // Destroy iSCSI global vector - iscsi_destroy(); - pthread_rwlock_destroy( &iscsi_globvec_rwlock ); - // Clean up images retries = 5; while ( !image_tryFreeAll() && --retries > 0 ) { @@ -371,11 +366,6 @@ int main(int argc, char *argv[]) integrity_init(); net_init(); - if ( _iSCSIServer ) { - if ( (pthread_rwlock_init( &iscsi_globvec_rwlock, NULL ) != 0) || (iscsi_create() < 0) ) - return EXIT_FAILURE; - } - uplink_globalsInit(); rpc_init(); if ( mountDir != NULL && !dfuse_init( "-oallow_other", mountDir ) ) { diff --git a/src/server/uplink.c b/src/server/uplink.c index 8a83124..e05d27c 100644 --- a/src/server/uplink.c +++ b/src/server/uplink.c @@ -228,12 +228,12 @@ static void freeUplinkStruct(ref *ref) * Remove given client from uplink request queue * Locks on: uplink.queueLock */ -void uplink_removeEntry(dnbd3_uplink_t *uplink, void *data, uplink_callback callback) +void uplink_removeEntry(dnbd3_uplink_t *uplink, void *data) { mutex_lock( &uplink->queueLock ); for ( dnbd3_queue_entry_t *it = uplink->queue; it != NULL; it = it->next ) { for ( dnbd3_queue_client_t **cit = &it->clients; *cit != NULL; ) { - if ( (**cit).data == data && (**cit).callback == callback ) { + if ( (**cit).data == data ) { (*(**cit).callback)( (**cit).data, (**cit).handle, 0, 0, NULL ); dnbd3_queue_client_t *entry = *cit; *cit = (**cit).next; diff --git a/src/server/uplink.h b/src/server/uplink.h index b6037d6..8d99695 100644 --- a/src/server/uplink.h +++ b/src/server/uplink.h @@ -10,7 +10,7 @@ uint64_t uplink_getTotalBytesReceived(); bool uplink_init(dnbd3_image_t *image, int sock, dnbd3_host_t *host, int version); -void uplink_removeEntry(dnbd3_uplink_t *uplink, void *data, uplink_callback callback); +void uplink_removeEntry(dnbd3_uplink_t *uplink, void *data); bool uplink_requestClient(dnbd3_client_t *client, uplink_callback callback, uint64_t handle, uint64_t start, uint32_t length, uint8_t hops); |