a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Copyright (C) 2006 Michael Brown <mbrown@fensystems.co.uk>.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is free software; you can redistribute it and/or
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * modify it under the terms of the GNU General Public License as
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * published by the Free Software Foundation; either version 2 of the
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * License, or any later version.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This program is distributed in the hope that it will be useful, but
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * WITHOUT ANY WARRANTY; without even the implied warranty of
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * General Public License for more details.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * You should have received a copy of the GNU General Public License
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * along with this program; if not, write to the Free Software
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iSCSI protocol
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncFEATURE ( FEATURE_PROTOCOL, "iSCSI", DHCP_EB_FEATURE_ISCSI, 1 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/* Disambiguate the various error causes */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EACCES_INCORRECT_TARGET_USERNAME )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EACCES, 0x01, "Incorrect target username" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EACCES_INCORRECT_TARGET_PASSWORD )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EACCES, 0x02, "Incorrect target password" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EINVAL, 0x01, "Root path too short" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EINVAL, 0x02, "Bad credential mix" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EINVAL, 0x03, "No root path" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EINVAL, 0x04, "No target IQN" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EINVAL, 0x05, "No initiator IQN" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EIO, 0x01, "Target not currently operational" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EIO, 0x02, "Target out of resources" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_ENOTSUP, 0x01, "Unsupported initiator status" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_ENOTSUP, 0x02, "Unsupported opcode" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_ENOTSUP, 0x03, "Discovery not supported" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_ENOTSUP, 0x04, "Unsupported target status" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_ENOTSUP, 0x05, "Unsupported NOP-In received" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EPERM_INITIATOR_AUTHENTICATION )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPERM, 0x01, "Initiator authentication failed" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EPERM_INITIATOR_AUTHORISATION )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPERM, 0x02, "Initiator not authorised" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EPROTO_INVALID_CHAP_ALGORITHM )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPROTO, 0x01, "Invalid CHAP algorithm" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EPROTO_INVALID_CHAP_IDENTIFIER )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPROTO, 0x02, "Invalid CHAP identifier" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EPROTO_INVALID_LARGE_BINARY )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPROTO, 0x03, "Invalid large binary" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EPROTO_INVALID_CHAP_RESPONSE )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPROTO, 0x04, "Invalid CHAP response" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_error ( EINFO_EPROTO_INVALID_KEY_VALUE_PAIR )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPROTO, 0x05, "Invalid key/value pair" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync __einfo_uniqify ( EINFO_EPROTO, 0x06, "Parameter rejected" )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_start_tx ( struct iscsi_session *iscsi );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_start_login ( struct iscsi_session *iscsi );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_start_data_out ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unsigned int datasn );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Finish receiving PDU data into buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_rx_buffered_data_done ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive PDU data into buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Data to receive
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This can be used when the RX PDU type handler wishes to buffer up
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * all received data and process the PDU as a single unit. The caller
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * is repsonsible for calling iscsi_rx_buffered_data_done() after
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * processing the data.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_buffered_data ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Allocate buffer on first call */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Copy data to buffer */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync assert ( ( iscsi->rx_offset + len ) <= iscsi->rx_len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync memcpy ( ( iscsi->rx_buffer + iscsi->rx_offset ), data, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Free iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v refcnt Reference counter
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync container_of ( refcnt, struct iscsi_session, refcnt );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Shut down iSCSI interface
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v rc Reason for close
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_close ( struct iscsi_session *iscsi, int rc ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* A TCP graceful close is still an error from our point of view */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( rc == 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p closed: %s\n", iscsi, strerror ( rc ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Stop transmission process */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Shut down interfaces */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Assign new iSCSI initiator task tag
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_new_itt ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Open iSCSI transport-layer connection
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_open_connection ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Open socket */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = xfer_open_named_socket ( &iscsi->socket, SOCK_STREAM,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync NULL ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not open socket: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Enter security negotiation phase */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->status = ( ISCSI_STATUS_SECURITY_NEGOTIATION_PHASE |
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->status |= ISCSI_STATUS_AUTH_REVERSE_REQUIRED;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Assign new ISID */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Assign fresh initiator task tag */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Initiate login */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Close iSCSI transport-layer connection
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v rc Reason for close
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Closes the transport-layer connection and resets the session state
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * ready to attempt a fresh login.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_close_connection ( struct iscsi_session *iscsi, int rc ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Close all data transfer interfaces */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Clear connection status */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Reset TX and RX state machines */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Free any temporary dynamically allocated memory */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Mark iSCSI SCSI operation as complete
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v rsp SCSI response, if any
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Note that iscsi_scsi_done() will not close the connection, and must
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * therefore be called only when the internal state machines are in an
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * appropriate state, otherwise bad things may happen on the next call
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * to iscsi_scsi_command(). The general rule is to call
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iscsi_scsi_done() only at the end of receiving a PDU; at this point
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the TX and RX engines should both be idle.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_scsi_done ( struct iscsi_session *iscsi, int rc,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Clear command */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Send SCSI response, if any */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Close SCSI command, if this is still the same command. (It
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * is possible that the command interface has already been
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * closed as a result of the SCSI response we sent.)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/****************************************************************************
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iSCSI SCSI command issuing
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Build iSCSI SCSI command BHS
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * We don't currently support bidirectional commands (i.e. with both
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Data-In and Data-Out segments); these would require providing code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * to generate an AHS, and there doesn't seem to be any need for it at
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the moment.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_start_command ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_scsi_command *command = &iscsi->tx_bhs.scsi_command;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync assert ( ! ( iscsi->command->data_in && iscsi->command->data_out ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Construct BHS and initiate transmission */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* lengths left as zero */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync command->exp_len = htonl ( iscsi->command->data_in_len |
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync memcpy ( &command->cdb, &iscsi->command->cdb, sizeof ( command->cdb ));
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC2 ( iscsi, "iSCSI %p start " SCSI_CDB_FORMAT " %s %#zx\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive data segment of an iSCSI SCSI response PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_scsi_response ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Buffer up the PDU data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_rx_buffered_data ( iscsi, data, len ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not buffer login response: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Parse SCSI response and discard buffer */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync residual_count = ntohl ( response->residual_count );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( response->flags & ISCSI_DATA_FLAG_OVERFLOW ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync } else if ( response->flags & ISCSI_DATA_FLAG_UNDERFLOW ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for errors */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( response->response != ISCSI_RESPONSE_COMMAND_COMPLETE )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Mark as completed */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive data segment of an iSCSI data-in PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_data_in ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_data_in *data_in = &iscsi->rx_bhs.data_in;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Copy data to data-in buffer */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync offset = ntohl ( data_in->offset ) + iscsi->rx_offset;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync assert ( ( offset + len ) <= iscsi->command->data_in_len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync copy_to_user ( iscsi->command->data_in, offset, data, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Wait for whole SCSI response to arrive */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Mark as completed if status is present */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync assert ( ( offset + len ) == iscsi->command->data_in_len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* iSCSI cannot return an error status via a data-in */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive data segment of an iSCSI R2T PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_r2t ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Record transfer parameters and trigger first data-out */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Build iSCSI data-out BHS
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v datasn Data sequence number within the transfer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_start_data_out ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unsigned int datasn ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* We always send 512-byte Data-Out PDUs; this removes the
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * need to worry about the target's MaxRecvDataSegmentLength.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Construct BHS and initiate transmission */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync data_out->offset = htonl ( iscsi->transfer_offset + offset );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p start data out DataSN %#x len %#lx\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Complete iSCSI data-out PDU transmission
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_data_out_done ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* If we haven't reached the end of the sequence, start
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * sending the next data-out PDU.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi_start_data_out ( iscsi, ntohl ( data_out->datasn ) + 1 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Send iSCSI data-out data segment
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_tx_data_out ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_data_out *data_out = &iscsi->tx_bhs.data_out;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync pad_len = ISCSI_DATA_PAD_LEN ( data_out->lengths );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync assert ( ( offset + len ) <= iscsi->command->data_out_len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iobuf = xfer_alloc_iob ( &iscsi->socket, ( len + pad_len ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive data segment of an iSCSI NOP-In
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_nop_in ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_nop_in *nop_in = &iscsi->rx_bhs.nop_in;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC2 ( iscsi, "iSCSI %p received NOP-In\n", iscsi );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* We don't currently have the ability to respond to NOP-Ins
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * sent as ping requests, but we can happily accept NOP-Ins
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * sent merely to update CmdSN.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( nop_in->ttt != htonl ( ISCSI_TAG_RESERVED ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p received unsupported NOP-In with TTT "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/****************************************************************************
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iSCSI login
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Build iSCSI login request strings
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * These are the initial set of strings sent in the first login
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * request PDU. We want the following settings:
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * HeaderDigest=None
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * DataDigest=None
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MaxConnections is irrelevant; we make only one connection anyway [4]
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * InitialR2T=Yes [1]
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * ImmediateData is irrelevant; we never send immediate data [4]
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MaxRecvDataSegmentLength=8192 (default; we don't care) [3]
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MaxBurstLength=262144 (default; we don't care) [3]
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * FirstBurstLength=262144 (default; we don't care)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * DefaultTime2Wait=0 [2]
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * DefaultTime2Retain=0 [2]
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * MaxOutstandingR2T=1
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * DataPDUInOrder=Yes
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * DataSequenceInOrder=Yes
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * ErrorRecoveryLevel=0
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * [1] InitialR2T has an OR resolution function, so the target may
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * force us to use it. We therefore simplify our logic by always
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * using it.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * [2] These ensure that we can safely start a new task once we have
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * reconnected after a failure, without having to manually tidy up
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * after the old one.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * [3] We are quite happy to use the RFC-defined default values for
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * these parameters, but some targets (notably OpenSolaris)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * incorrectly assume a default value of zero, so we explicitly
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * specify the default values.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * [4] We are quite happy to use the RFC-defined default values for
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * these parameters, but some targets (notably a QNAP TS-639Pro) fail
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * unless they are supplied, so we explicitly specify the default
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_build_login_request_strings ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( iscsi->status & ISCSI_STATUS_STRINGS_SECURITY ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Default to allowing no authentication */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* If we have a credential to supply, permit CHAP */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* If we have a credential to check, force CHAP */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "InitiatorName=%s%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "TargetName=%s%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "SessionType=Normal%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "AuthMethod=%s%c",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_ALGORITHM ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync used += ssnprintf ( data + used, len - used, "CHAP_A=5%c", 0 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_RESPONSE ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync char buf[ base16_encoded_len ( iscsi->chap.response_len ) + 1 ];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync base16_encode ( iscsi->chap.response, iscsi->chap.response_len,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "CHAP_N=%s%cCHAP_R=0x%s%c",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( iscsi->status & ISCSI_STATUS_STRINGS_CHAP_CHALLENGE ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync size_t challenge_len = ( sizeof ( iscsi->chap_challenge ) - 1 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync char buf[ base16_encoded_len ( challenge_len ) + 1 ];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync base16_encode ( ( iscsi->chap_challenge + 1 ), challenge_len,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "CHAP_I=%d%cCHAP_C=0x%s%c",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( iscsi->status & ISCSI_STATUS_STRINGS_OPERATIONAL ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "HeaderDigest=None%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "DataDigest=None%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "MaxConnections=1%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "InitialR2T=Yes%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "ImmediateData=No%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "MaxRecvDataSegmentLength=8192%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "MaxBurstLength=262144%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "DefaultTime2Wait=0%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "DefaultTime2Retain=0%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "MaxOutstandingR2T=1%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "DataPDUInOrder=Yes%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "DataSequenceInOrder=Yes%c"
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "ErrorRecoveryLevel=0%c",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Build iSCSI login request BHS
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_start_login ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_login_request *request = &iscsi->tx_bhs.login_request;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p entering security negotiation\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p entering operational negotiation\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Construct BHS and initiate transmission */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync request->flags = ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) |
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* version_max and version_min left as zero */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync len = iscsi_build_login_request_strings ( iscsi, NULL, 0 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync request->isid_iana_qual = htons ( iscsi->isid_iana_qual );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* tsih left as zero */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* cid left as zero */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Complete iSCSI login request PDU transmission
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_login_request_done ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Clear any "strings to send" flags */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Free any dynamically allocated storage used for login */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Transmit data segment of an iSCSI login request PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * For login requests, the data segment consists of the login strings.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_tx_login_request ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_login_request *request = &iscsi->tx_bhs.login_request;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iobuf = xfer_alloc_iob ( &iscsi->socket, ( len + pad_len ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi_build_login_request_strings ( iscsi, iobuf->data, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Calculate maximum length of decoded large binary value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v encoded Encoded large binary value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v max_raw_len Maximum length of raw data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic inline size_t
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsynciscsi_large_binary_decoded_max_len ( const char *encoded ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return ( strlen ( encoded ) ); /* Decoding never expands data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Decode large binary value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v encoded Encoded large binary value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v raw Raw data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret len Length of raw data, or negative error
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_large_binary_decode ( const char *encoded, uint8_t *raw ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI TargetAddress text value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value TargetAddress value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_targetaddress_value ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p will redirect to %s\n", iscsi, value );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Replace target address */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Replace target port */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->target_port = strtoul ( ( separator + 1 ), NULL, 0 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI AuthMethod text value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value AuthMethod value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_authmethod_value ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* If server requests CHAP, send the CHAP_A string */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p initiating CHAP authentication\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->status |= ( ISCSI_STATUS_STRINGS_CHAP_ALGORITHM |
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI CHAP_A text value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value CHAP_A value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_chap_a_value ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* We only ever offer "5" (i.e. MD5) as an algorithm, so if
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the server responds with anything else it is a protocol
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * violation.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p got invalid CHAP algorithm \"%s\"\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI CHAP_I text value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value CHAP_I value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_chap_i_value ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* The CHAP identifier is an integer value */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p saw invalid CHAP identifier \"%s\"\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Prepare for CHAP with MD5 */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = chap_init ( &iscsi->chap, &md5_algorithm ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not initialise CHAP: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Identifier and secret are the first two components of the
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * challenge.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync chap_update ( &iscsi->chap, iscsi->initiator_password,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI CHAP_C text value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value CHAP_C value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_chap_c_value ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync uint8_t buf[ iscsi_large_binary_decoded_max_len ( value ) ];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unsigned int i;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Process challenge */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( rc < 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p invalid CHAP challenge \"%s\": %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Build CHAP response */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p sending CHAP response\n", iscsi );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->status |= ISCSI_STATUS_STRINGS_CHAP_RESPONSE;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Send CHAP challenge, if applicable */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->status |= ISCSI_STATUS_STRINGS_CHAP_CHALLENGE;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Generate CHAP challenge data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync for ( i = 0 ; i < sizeof ( iscsi->chap_challenge ) ; i++ ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI CHAP_N text value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value CHAP_N value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_chap_n_value ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* The target username isn't actually involved at any point in
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the authentication process; it merely serves to identify
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * which password the target is using to generate the CHAP
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * response. We unnecessarily verify that the username is as
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * expected, in order to provide mildly helpful diagnostics if
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the target is supplying the wrong username/password
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * combination.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( strcmp ( iscsi->target_username, value ) != 0 ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p target username \"%s\" incorrect "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync "(wanted \"%s\")\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI CHAP_R text value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value CHAP_R value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_chap_r_value ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *value ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync uint8_t buf[ iscsi_large_binary_decoded_max_len ( value ) ];
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Generate CHAP response for verification */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = chap_init ( &iscsi->chap, &md5_algorithm ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not initialise CHAP: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync chap_set_identifier ( &iscsi->chap, iscsi->chap_challenge[0] );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync chap_update ( &iscsi->chap, iscsi->target_password,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync chap_update ( &iscsi->chap, &iscsi->chap_challenge[1],
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Process response */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( rc < 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p invalid CHAP response \"%s\": %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check CHAP response */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p invalid CHAP response length\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( memcmp ( buf, iscsi->chap.response, len ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p incorrect CHAP response \"%s\"\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Mark session as authenticated */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** An iSCSI text string that we want to handle */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /** String key
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This is the portion preceding the "=" sign,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * e.g. "InitiatorName", "CHAP_A", etc.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /** Handle iSCSI string value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v value iSCSI string value
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync int ( * handle ) ( struct iscsi_session *iscsi, const char *value );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI text strings that we want to handle */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct iscsi_string_type iscsi_string_types[] = {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync { "TargetAddress", iscsi_handle_targetaddress_value },
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI string
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v string iSCSI string (in "key=value" format)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_string ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *string ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Find separator */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for rejections. Since we send only non-rejectable
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * values, any rejection is a fatal protocol error.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p rejection: %s\n", iscsi, string );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Handle key/value pair */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync for ( type = iscsi_string_types ; type->key ; type++ ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p handling %s\n", iscsi, string );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = type->handle ( iscsi, value ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not handle %s: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p ignoring %s\n", iscsi, string );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle iSCSI strings
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v string iSCSI string buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of string buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_handle_strings ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Handle each string in turn, taking care not to overrun the
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * data buffer in case of badly-terminated data.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync while ( 1 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_handle_string ( iscsi, strings ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Convert iSCSI response status to return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v status_class iSCSI status class
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v status_detail iSCSI status detail
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_status_to_rc ( unsigned int status_class,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync unsigned int status_detail ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive data segment of an iSCSI login response PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_login_response ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Buffer up the PDU data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_rx_buffered_data ( iscsi, data, len ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not buffer login response: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Process string data and discard string buffer */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_handle_strings ( iscsi, iscsi->rx_buffer,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for login redirection */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( response->status_class == ISCSI_STATUS_REDIRECT ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p redirecting to new server\n", iscsi );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not redirect: %s\n ",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for fatal errors */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI login failure: class %02x detail %02x\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Handle login transitions */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( response->flags & ISCSI_LOGIN_FLAG_TRANSITION ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync switch ( response->flags & ISCSI_LOGIN_NSG_MASK ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p got invalid response flags "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Send next login request PDU if we haven't reached the full
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * feature phase yet.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) !=
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check that target authentication was successful (if required) */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( iscsi->status & ISCSI_STATUS_AUTH_REVERSE_REQUIRED ) &&
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ! ( iscsi->status & ISCSI_STATUS_AUTH_REVERSE_OK ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p nefarious target tried to bypass "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Notify SCSI layer of window change */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p entering full feature phase\n", iscsi );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/****************************************************************************
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iSCSI to socket interface
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Pause TX engine
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_tx_pause ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Resume TX engine
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_tx_resume ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Start up a new TX PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This initiates the process of sending a new PDU. Only one PDU may
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * be in transit at any one time.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_start_tx ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Initialise TX BHS */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync memset ( &iscsi->tx_bhs, 0, sizeof ( iscsi->tx_bhs ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Flag TX engine to start transmitting */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Start transmission process */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Transmit nothing
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_tx_nothing ( struct iscsi_session *iscsi __unused ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Transmit basic header segment of an iSCSI PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_tx_bhs ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return xfer_deliver_raw ( &iscsi->socket, &iscsi->tx_bhs,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Transmit data segment of an iSCSI PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle transmission of part of a PDU data segment. iscsi::tx_bhs
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * will be valid when this is called.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_tx_data ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Nothing to send in other states */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Complete iSCSI PDU transmission
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Called when a PDU has been completely transmitted and the TX state
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * machine is about to enter the idle state. iscsi::tx_bhs will be
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * valid for the just-completed PDU when this is called.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_tx_done ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Stop transmission process */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* No action */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Transmit iSCSI PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v buf Temporary data buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of temporary data buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Constructs data to be sent for the current TX state
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_tx_step ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_common *common = &iscsi->tx_bhs.common;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Select fragment to transmit */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync while ( 1 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Nothing to do; pause processing */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for window availability, if needed */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( tx_len && ( xfer_window ( &iscsi->socket ) == 0 ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Cannot transmit at this point; pause
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * processing and wait for window to reopen
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Transmit data */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Transmission errors are fatal */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Move to next state */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* If we have moved to the idle state, mark
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * transmission as complete
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI TX process descriptor */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct process_descriptor iscsi_process_desc =
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync PROC_DESC ( struct iscsi_session, process, iscsi_tx_step );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive basic header segment of an iSCSI PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This fills in iscsi::rx_bhs with the data from the BHS portion of
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the received PDU.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_bhs ( struct iscsi_session *iscsi, const void *data,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync memcpy ( &iscsi->rx_bhs.bytes[iscsi->rx_offset], data, len );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( iscsi->rx_offset + len ) >= sizeof ( iscsi->rx_bhs ) ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC2 ( iscsi, "iSCSI %p received PDU opcode %#x len %#x\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Discard portion of an iSCSI PDU.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This discards data from a portion of a received PDU.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_discard ( struct iscsi_session *iscsi __unused,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Do nothing */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive data segment of an iSCSI PDU
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v data Received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v len Length of received data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v remaining Data remaining after this data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle processing of part of a PDU data segment. iscsi::rx_bhs
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * will be valid when this is called.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_rx_data ( struct iscsi_session *iscsi, const void *data,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Update cmdsn and statsn */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return iscsi_rx_login_response ( iscsi, data, len, remaining );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return iscsi_rx_scsi_response ( iscsi, data, len, remaining );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return iscsi_rx_data_in ( iscsi, data, len, remaining );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return iscsi_rx_r2t ( iscsi, data, len, remaining );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return iscsi_rx_nop_in ( iscsi, data, len, remaining );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p unknown opcode %02x\n", iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Receive new data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iobuf I/O buffer
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v meta Data transfer metadata
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * This handles received PDUs. The receive strategy is to fill in
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iscsi::rx_bhs with the contents of the BHS portion of the PDU,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * throw away any AHS portion, and then process each part of the data
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * portion as it arrives. The data processing routine therefore
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * always has a full copy of the BHS available, even for portions of
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * the data in different packets to the BHS.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_socket_deliver ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync struct iscsi_bhs_common *common = &iscsi->rx_bhs.common;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync int ( * rx ) ( struct iscsi_session *iscsi, const void *data,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync while ( 1 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->rx_len = 4 * ISCSI_AHS_LEN ( common->lengths );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->rx_len = ISCSI_DATA_LEN ( common->lengths );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->rx_len = ISCSI_DATA_PAD_LEN ( common->lengths );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync remaining = iscsi->rx_len - iscsi->rx_offset - frag_len;
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not process received "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* If all the data for this state has not yet been
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * received, stay in this state for now.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Free I/O buffer */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Destroy session on error */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( rc != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Handle redirection event
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v type Location type
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v args Remaining arguments depend upon location type
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_vredirect ( struct iscsi_session *iscsi, int type,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Intercept redirects to a LOCATION_SOCKET and record the IP
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * address for the iBFT. This is a bit of a hack, but avoids
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * inventing an ioctl()-style call to retrieve the socket
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * address from a data-xfer interface.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( void ) va_arg ( tmp, int ); /* Discard "semantics" */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync return xfer_vreopen ( &iscsi->socket, type, args );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI socket interface operations */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct interface_operation iscsi_socket_operations[] = {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( xfer_deliver, struct iscsi_session *, iscsi_socket_deliver ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( xfer_window_changed, struct iscsi_session *,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( xfer_vredirect, struct iscsi_session *, iscsi_vredirect ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( intf_close, struct iscsi_session *, iscsi_close ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI socket interface descriptor */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct interface_descriptor iscsi_socket_desc =
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_DESC ( struct iscsi_session, socket, iscsi_socket_operations );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/****************************************************************************
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * iSCSI command issuing
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Check iSCSI flow-control window
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret len Length of window
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic size_t iscsi_scsi_window ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( ( iscsi->status & ISCSI_STATUS_PHASE_MASK ) ==
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* We cannot handle concurrent commands */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Issue iSCSI SCSI command
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v parent Parent interface
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v command SCSI command
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret tag Command tag, or negative error
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_scsi_command ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* This iSCSI implementation cannot handle multiple concurrent
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * commands or commands arriving before login is complete.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p cannot handle concurrent commands\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Store command */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync memcpy ( iscsi->command, command, sizeof ( *command ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Assign new ITT */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Start sending command */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Attach to parent interface and return */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI SCSI command-issuing interface operations */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct interface_operation iscsi_control_op[] = {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( scsi_command, struct iscsi_session *, iscsi_scsi_command ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( xfer_window, struct iscsi_session *, iscsi_scsi_window ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( intf_close, struct iscsi_session *, iscsi_close ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( acpi_describe, struct iscsi_session *, ibft_describe ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI SCSI command-issuing interface descriptor */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct interface_descriptor iscsi_control_desc =
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_DESC ( struct iscsi_session, control, iscsi_control_op );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Close iSCSI command
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v rc Reason for close
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic void iscsi_command_close ( struct iscsi_session *iscsi, int rc ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Restart interface */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Treat unsolicited command closures mid-command as fatal,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * because we have no code to handle partially-completed PDUs.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi_close ( iscsi, ( ( rc == 0 ) ? -ECANCELED : rc ) );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI SCSI command interface operations */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct interface_operation iscsi_data_op[] = {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_OP ( intf_close, struct iscsi_session *, iscsi_command_close ),
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI SCSI command interface descriptor */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic struct interface_descriptor iscsi_data_desc =
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync INTF_DESC ( struct iscsi_session, data, iscsi_data_op );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/****************************************************************************
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Instantiator
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI root path components (as per RFC4173) */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI initiator IQN setting */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstruct setting initiator_iqn_setting __setting ( SETTING_SANBOOT_EXTRA ) = {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI reverse username setting */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstruct setting reverse_username_setting __setting ( SETTING_AUTH_EXTRA ) = {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI reverse password setting */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstruct setting reverse_password_setting __setting ( SETTING_AUTH_EXTRA ) = {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Parse iSCSI root path
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v root_path iSCSI root path (as per RFC4173)
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_parse_root_path ( struct iscsi_session *iscsi,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync const char *root_path ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Split root path into component parts */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync while ( 1 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ! *rp ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Use root path components to configure iSCSI session */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->target_address = strdup ( rp_comp[RP_SERVERNAME] );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->target_port = strtoul ( rp_comp[RP_PORT], NULL, 10 );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = scsi_parse_lun ( rp_comp[RP_LUN], &iscsi->lun ) ) != 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync iscsi->target_iqn = strdup ( rp_comp[RP_TARGETNAME] );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Fetch iSCSI settings
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_fetch_settings ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Fetch relevant settings. Don't worry about freeing on
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * error, since iscsi_free() will take care of that anyway.
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( len = fetch_string_setting_copy ( NULL, &username_setting,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not fetch username: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( len = fetch_string_setting_copy ( NULL, &password_setting,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not fetch password: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( len = fetch_string_setting_copy( NULL, &reverse_username_setting,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not fetch reverse username: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( len = fetch_string_setting_copy( NULL, &reverse_password_setting,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not fetch reverse password: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Find a suitable initiator name */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( len = fetch_string_setting_copy ( NULL, &initiator_iqn_setting,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not fetch initiator IQN: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( len = fetch_string_setting_copy ( NULL, &hostname_setting,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync &hostname ) ) < 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not fetch hostname: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( len < 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not allocate initiator "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( len = fetch_uuid_setting ( NULL, &uuid_setting, &uuid ) ) < 0 ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p has no suitable initiator IQN\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not allocate initiator IQN\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Check iSCSI authentication details
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v iscsi iSCSI session
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_check_auth ( struct iscsi_session *iscsi ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Check for invalid authentication combinations */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( /* Initiator username without password (or vice-versa) */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( /* Target username without password (or vice-versa) */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync ( /* Target (reverse) without initiator (forward) */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p invalid credentials: initiator "
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * Open iSCSI URI
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v parent Parent interface
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @v uri URI
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync * @ret rc Return status code
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsyncstatic int iscsi_open ( struct interface *parent, struct uri *uri ) {
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Sanity check */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Allocate and initialise structure */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync intf_init ( &iscsi->control, &iscsi_control_desc, &iscsi->refcnt );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync intf_init ( &iscsi->data, &iscsi_data_desc, &iscsi->refcnt );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync intf_init ( &iscsi->socket, &iscsi_socket_desc, &iscsi->refcnt );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync process_init_stopped ( &iscsi->process, &iscsi_process_desc,
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Parse root path */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_parse_root_path ( iscsi, uri->opaque ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Set fields not specified by root path */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_fetch_settings ( iscsi ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Validate authentication */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Sanity checks */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p does not yet support discovery\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p no target address supplied in %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p initiator %s\n",iscsi, iscsi->initiator_iqn );
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Open socket */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync if ( ( rc = iscsi_open_connection ( iscsi ) ) != 0 )
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Attach SCSI device to parent interface */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync DBGC ( iscsi, "iSCSI %p could not create SCSI device: %s\n",
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync /* Mortalise self, and return */
a734c64bff58bda2fa48c2795453e092167b0ff7vboxsync/** iSCSI URI opener */