/**
* Copyright (c) 2012, University of Konstanz, Distributed Systems Group All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
* following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of
* conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation and/or other materials provided with the
* distribution. * Neither the name of the University of Konstanz nor the names of its contributors may be used to
* endorse or promote products derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
* OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
* STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
* EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
package org.jscsi.initiator.connection.state;
import java.util.LinkedList;
import java.util.Queue;
import org.jscsi.exception.InternetSCSIException;
import org.jscsi.initiator.connection.Connection;
import org.jscsi.parser.OperationCode;
import org.jscsi.parser.ProtocolDataUnit;
import org.jscsi.parser.data.DataOutParser;
import org.jscsi.parser.datasegment.IDataSegmentIterator;
import org.jscsi.parser.datasegment.IDataSegmentIterator.IDataSegmentChunk;
import org.jscsi.parser.datasegment.OperationalTextKey;
/**
* <h1>WriteFirstBurstState</h1>
* <p/>
* This state handles a first Write Sending State, which sends at most <code>FirstBurstLength</code> bytes in the first
* sequence.
*
* @author Volker Wildi
*/
public final class WriteFirstBurstState extends AbstractState {
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** The iterator of this data segment to send as next. */
private IDataSegmentIterator iterator;
/**
* The Target Transfer Tag, which is sent by the iSCSI Target within a Ready2Transfer PDU.
*/
private final int targetTransferTag;
/** The sequence number of this data package unit. */
private int dataSequenceNumber;
/** The start offset of the data to send. */
private int bufferOffset;
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/**
* Constructor to create a <code>WriteFirstBurstState</code> instance, which sends the first data sequence.
*
* @param initConnection This is the connection, which is used for the network transmission.
* @param initIterator The next chunk of the data to send.
* @param initTargetTransferTag The Target Transfer Tag to use as next.
* @param initDataSequenceNumber The Data Sequence Number to use as next.
* @param initBufferOffset The start offset of the data to send.
*/
public WriteFirstBurstState (final Connection initConnection, final IDataSegmentIterator initIterator, final int initTargetTransferTag, final int initDataSequenceNumber, final int initBufferOffset) {
super(initConnection);
iterator = initIterator;
targetTransferTag = initTargetTransferTag;
dataSequenceNumber = initDataSequenceNumber;
bufferOffset = initBufferOffset;
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
/** {@inheritDoc} */
public final void execute () throws InternetSCSIException {
final Queue<ProtocolDataUnit> protocolDataUnits = new LinkedList<ProtocolDataUnit>();
ProtocolDataUnit protocolDataUnit;
DataOutParser dataOut;
IDataSegmentChunk dataSegmentChunk;
boolean finalFlag = false;
final int maxRecvDataSegmentLength = connection.getSettingAsInt(OperationalTextKey.MAX_RECV_DATA_SEGMENT_LENGTH);
// the remaining bytes to send (do not forget the immediately send
// data!)
int bytes2Transfer = connection.getSettingAsInt(OperationalTextKey.FIRST_BURST_LENGTH) - bufferOffset;
while (bytes2Transfer > 0 && iterator.hasNext()) {
if (bytes2Transfer <= maxRecvDataSegmentLength) {
dataSegmentChunk = iterator.next(bytes2Transfer);
finalFlag = true;
} else {
dataSegmentChunk = iterator.next(maxRecvDataSegmentLength);
finalFlag = false;
}
protocolDataUnit = protocolDataUnitFactory.create(false, finalFlag, OperationCode.SCSI_DATA_OUT, connection.getSetting(OperationalTextKey.HEADER_DIGEST), connection.getSetting(OperationalTextKey.DATA_DIGEST));
protocolDataUnit.getBasicHeaderSegment().setInitiatorTaskTag(connection.getSession().getInitiatorTaskTag());
dataOut = (DataOutParser) protocolDataUnit.getBasicHeaderSegment().getParser();
dataOut.setTargetTransferTag(targetTransferTag);
dataOut.setDataSequenceNumber(dataSequenceNumber++);
dataOut.setBufferOffset(bufferOffset);
bufferOffset += maxRecvDataSegmentLength;
protocolDataUnit.setDataSegment(dataSegmentChunk);
protocolDataUnits.offer(protocolDataUnit);
bytes2Transfer -= maxRecvDataSegmentLength;
}
connection.send(protocolDataUnits);
connection.nextState(new WriteSecondResponseState(connection, iterator, dataSequenceNumber, bufferOffset));
super.stateFollowing = true;
// return true;
}
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
// --------------------------------------------------------------------------
}