Support for continuous runs

[iperf] / src / Client.cpp

/*--------------------------------------------------------------- 
 * Copyright (c) 1999,2000,2001,2002,2003                              
 * The Board of Trustees of the University of Illinois            
 * All Rights Reserved.                                           
 *--------------------------------------------------------------- 
 * Permission is hereby granted, free of charge, to any person    
 * obtaining a copy of this software (Iperf) and associated       
 * documentation files (the "Software"), to deal in the Software  
 * without restriction, including without limitation the          
 * rights to use, copy, modify, merge, publish, distribute,        
 * sublicense, and/or sell copies of the Software, and to permit     
 * persons to whom the Software is furnished to do
 * so, subject to the following conditions: 
 *
 *     
 * Redistributions of source code must retain the above 
 * copyright notice, this list of conditions and 
 * the following disclaimers. 
 *
 *     
 * Redistributions in binary form must reproduce the above 
 * copyright notice, this list of conditions and the following 
 * disclaimers in the documentation and/or other materials 
 * provided with the distribution. 
 * 
 *     
 * Neither the names of the University of Illinois, NCSA, 
 * nor the names of its contributors may be used to endorse 
 * or promote products derived from this Software without
 * specific prior written permission. 
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 
 * NONINFRINGEMENT. IN NO EVENT SHALL THE CONTIBUTORS OR COPYRIGHT 
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 
 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 * ________________________________________________________________
 * National Laboratory for Applied Network Research 
 * National Center for Supercomputing Applications 
 * University of Illinois at Urbana-Champaign 
 * http://www.ncsa.uiuc.edu
 * ________________________________________________________________ 
 *
 * Client.cpp
 * by Mark Gates <mgates@nlanr.net>
 * -------------------------------------------------------------------
 * A client thread initiates a connect to the server and handles
 * sending and receiving data, then closes the socket.
 * ------------------------------------------------------------------- */

#include "headers.h"
#include "Client.hpp"
#include "Thread.h"
#include "SocketAddr.h"
#include "PerfSocket.hpp"
#include "Extractor.h"
#include "delay.hpp"
#include "util.h"
#include "Locale.h"

/* -------------------------------------------------------------------
 * Store server hostname, optionally local hostname, and socket info.
 * ------------------------------------------------------------------- */

Client::Client( thread_Settings *inSettings ) {
    mSettings = inSettings;
    mBuf = NULL;

    // connect
    Connect( );

    // initialize buffer
    mBuf = new char[ mSettings->mBufLen ];
    pattern( mBuf, mSettings->mBufLen );
    if ( isFileInput( mSettings ) ) {
        if ( !isSTDIN( mSettings ) )
            Extractor_Initialize( mSettings->mFileName, mSettings->mBufLen, mSettings );
        else
            Extractor_InitializeFile( stdin, mSettings->mBufLen, mSettings );

        if ( !Extractor_canRead( mSettings ) ) {
            unsetFileInput( mSettings );
        }
    }

    if ( isReport( inSettings ) ) {
        ReportSettings( inSettings );
        if ( mSettings->multihdr && isMultipleReport( inSettings ) ) {
            mSettings->multihdr->report->connection.peer = mSettings->peer;
            mSettings->multihdr->report->connection.local = mSettings->local;
        }
    }

} // end Client

/* -------------------------------------------------------------------
 * Delete memory (hostname strings).
 * ------------------------------------------------------------------- */

Client::~Client() {
    if ( mSettings->mSock != INVALID_SOCKET ) {
        int rc = close( mSettings->mSock );
        WARN_errno( rc == SOCKET_ERROR, "close" );
        mSettings->mSock = INVALID_SOCKET;
    }
    DELETE_ARRAY( mBuf );
} // end ~Client

const double kSecs_to_usecs = 1.0e6;
const double kBytes_to_Bits = 8.0;

/* ------------------------------------------------------------------- 
 * Send data using the connected UDP/TCP socket, 
 * until a termination flag is reached. 
 * Does not close the socket. 
 * ------------------------------------------------------------------- */ 

void Client::Run( void ) {
    struct dgram_record* mBuf_Dgram = (struct dgram_record*) mBuf;
    long  currLen = 0, packet_gap = 0, delta, loop_time = 0, adjust = 0;
    char* readAt = mBuf;
    bool canRead = true,        // Indicates if the stream is readable
         mMode_Time = isModeTime( mSettings );
    ReportStruct *reportstruct = NULL;

    // setup termination variables
    if ( mMode_Time ) {
        mEndTime.setnow();
        if (mSettings->mAmount == 0)
            mEndTime.add(2209032.0);            // 7 years - i.e. continuous
        else
            mEndTime.add(mSettings->mAmount / 100.0);
    }

    if ( isPacketOriented( mSettings ) ) {
        // compute delay for bandwidth restriction, constrained to [0,1] seconds 
        packet_gap = (long)((double)(mSettings->mBufLen * kSecs_to_usecs * kBytes_to_Bits) /
                                                               (double)mSettings->mDgramRate);

        if (packet_gap < 0 || packet_gap > kSecs_to_usecs) {
            fprintf( stderr, warn_delay_large, packet_gap / kSecs_to_usecs );
            packet_gap = (long)kSecs_to_usecs;
        }
        // Initialise adjustment variable: in this way, the first adjustment will be
        // the latency for sending the first packet, and all sending times are
        // synchronised with regard to the first timestamp.
        adjust = -packet_gap;

        // Due to the included timestamps etc,
        // reduce the read size by an amount equal to the header size
        if ( isFileInput( mSettings ) ) {
            size_t offset = sizeof(struct dgram_record);

            if (!isCompat(mSettings))
                offset += sizeof(struct client_hdr);

            Extractor_reduceReadSize(offset, mSettings);
            readAt += offset;
        }
    }

    // InitReport handles Barrier for multiple Streams
    mSettings->reporthdr = InitReport( mSettings );
    reportstruct = new ReportStruct;

    // Connectionless protocols use the first message as "connect" message (which is
    // counted, but their FIN is not counted. For connection-oriented protocols we
    // start at message #1 instead of at #0; and the FIN is not counted.
    reportstruct->packetID = (!isConnectionLess(mSettings) && isPacketOriented(mSettings));

    // Set a timestamp now corresponding to an imaginary zero-th send time.
    lastPacketTime.setnow();

    do {
        // Test case: drop 17 packets and send 2 out-of-order: 
        // sequence 51, 52, 70, 53, 54, 71, 72 
        //switch( datagramID ) { 
        //  case 53: datagramID = 70; break; 
        //  case 71: datagramID = 53; break; 
        //  case 55: datagramID = 71; break; 
        //  default: break; 
        //} 

        // Note that the timestamp does not account for the time-to-wire of the packet.
        // This plays a role when looking at jitter/delay values.
        gettimeofday( &(reportstruct->packetTime), NULL );

        if ( isPacketOriented( mSettings ) ) {
            // Increment packet ID after sending and before reporting
            // UDP:  sends from 0..n-1, counts from 1..n
            // DCCP: sends from 1..n,   counts from 2..n+1
            // This difference is of interest for the client only (the server sees
            // 1..n). The client uses cntDatagrams, so that the count is correct.
            // (Consider the trick in CloseReport() which resetts packetID.)
            mBuf_Dgram->id      = htonl( reportstruct->packetID++ );
            mBuf_Dgram->tv_sec  = htonl( reportstruct->packetTime.tv_sec );
            mBuf_Dgram->tv_usec = htonl( reportstruct->packetTime.tv_usec );
        } else if (!mMode_Time && mSettings->mAmount < mSettings->mBufLen)
            mSettings->mBufLen = mSettings->mAmount;

        // Read the next data block from the file if it's file input
        if ( isFileInput( mSettings ) ) {
            Extractor_getNextDataBlock( readAt, mSettings ); 
            canRead = Extractor_canRead( mSettings ) != 0; 
        }

        // Put the packet onto the wire.
        // When EAGAIN is returned (DCCP), the internal TX buffer is full: due to
        // congestion-control issues the packet can not be transported now.
        do {
            currLen = write( mSettings->mSock, mBuf, mSettings->mBufLen );
        } while (currLen < 0 && errno == EAGAIN);

        if (currLen < 0) {
            WARN_errno(1, "client write");
            break;
        }
        // update statistics
        reportstruct->packetLen = currLen;
        ReportPacket( mSettings->reporthdr, reportstruct );

        if (mMode_Time) {
            // time-oriented mode (-t): termination
            canRead = mEndTime.after(reportstruct->packetTime);
        } else {
            // amount-oriented mode (-n): mAmount is unsigned
            if (currLen >= mSettings->mAmount)
                break;
            mSettings->mAmount -= currLen;
        }

        if (isPacketOriented(mSettings)) {
            // Adjust the inter-packet gap using the following variables:
            //   delta      is the gap in between calls to send()
            //   adjust     acts as a token bucket whenever delta != packet_gap
            //   loop_time  equals packet_gap if adjust==0, it is corrected otherwise
            //
            // TODO this doesn't work well in certain cases, like 2 parallel streams
            //
            delta = lastPacketTime.delta_usec();
            adjust += packet_gap - delta;
            loop_time = packet_gap + adjust;

            if (loop_time > 0)
                delay_loop(loop_time);
       }

    } while (canRead && !sInterupted);

    // stop timing
    gettimeofday( &(reportstruct->packetTime), NULL );
    CloseReport( mSettings->reporthdr, reportstruct );

    if ( isPacketOriented( mSettings ) ) {
        // send a final terminating datagram 
        // For connectionless protocols, don't count in the mTotalLen.
        // The server counts this one, but didn't count our first datagram
        // (connect message), so we're even now.

        // store datagram ID into buffer 
        // The negative datagram ID signifies termination to the server.
        mBuf_Dgram->id      = htonl( -(reportstruct->packetID)  );
        mBuf_Dgram->tv_sec  = htonl( reportstruct->packetTime.tv_sec );
        mBuf_Dgram->tv_usec = htonl( reportstruct->packetTime.tv_usec );

        if ( isMulticast( mSettings ) )
            write( mSettings->mSock, mBuf, mSettings->mBufLen ); 
        else
            write_dgram_FIN( );
    }
    DELETE_PTR( reportstruct );
    EndReport( mSettings->reporthdr );
} 

void Client::InitiateServer()
{
    client_hdr *temp_hdr = (client_hdr*)mBuf;

    if (isCompat(mSettings))
        return;
     // connection-less protocols communicate their settings in the first
     // packet sent to the server; this packet is not counted by the server
     if (isConnectionLess(mSettings)) {
        dgram_record *record_hdr = (dgram_record *)mBuf;
        temp_hdr = (client_hdr*)(record_hdr + 1);
      }

      Settings_GenerateClientHdr( mSettings, temp_hdr );

      // connection-oriented protocols use a short "init" message
      if ( !isConnectionLess( mSettings ) ) {
        int rc;

        do {
             rc = send(mSettings->mSock, mBuf, sizeof(client_hdr), 0);
        } while (rc < 0 && errno == EAGAIN);
        WARN_errno(rc < 0, "write failed in InitiateServer()");
      }
}

/* -------------------------------------------------------------------
 * Setup a socket connected to a server.
 * If inLocalhost is not null, bind to that address, specifying
 * which outgoing interface to use.
 * ------------------------------------------------------------------- */
void Client::Connect()
{
    socklen_t size_local = sizeof(mSettings->local);

    MakeSocket(mSettings);

    /* determine local interface after establishing the connection */
    getsockname(mSettings->mSock, (struct sockaddr *)&mSettings->local, &size_local);

    /* The DCCP packet size must not exceed the MPS (RFC 4340, 14.) */
    if (mSettings->mProtocol == kProto_DCCP) {
        unsigned mps = getsock_dccp_mps(mSettings->mSock);

        if (mSettings->mBufLen > mps)
           die("Buffer length %d exceeds DCCP MPS %d. Use a smaller buffer size "
               "(-l) on server/client.", mSettings->mBufLen, mps);
    }
}


/* ------------------------------------------------------------------- 
 * Send a datagram on the socket. The datagram's contents should signify 
 * a FIN to the application. Keep re-transmitting until an 
 * acknowledgement datagram is received. 
 * ------------------------------------------------------------------- */ 
void Client::write_dgram_FIN( ) {
    int rc, count = 0;
    fd_set readSet; 
    struct timeval timeout; 
    size_t len = mSettings->mBufLen;

    // we don't need the full buffer size here - it is not counted
    if (!isConnectionLess(mSettings))
        len = sizeof(dgram_record);

    while ( count < 10 ) {
        count++;

        // write data 
        write( mSettings->mSock, mBuf, len);

        // wait until the socket is readable, or our timeout expires 
        FD_ZERO( &readSet ); 
        FD_SET( mSettings->mSock, &readSet ); 
        timeout.tv_sec  = 0; 
        timeout.tv_usec = 250000; // quarter second, 250 ms 

        rc = select( mSettings->mSock+1, &readSet, NULL, NULL, &timeout ); 
        FAIL_errno( rc == SOCKET_ERROR, "select", mSettings ); 

        if ( rc == 0 ) {
            // select timed out 
            continue; 
        } else {
            // socket ready to read 
            rc = read( mSettings->mSock, mBuf, mSettings->mBufLen ); 
            WARN_errno( rc < 0, "read" );
            if ( rc < 0 ) {
                break;
            } else if ( rc >= (int) (sizeof(dgram_record) + sizeof(server_hdr)) ) {
                ReportServerUDP( mSettings, (server_hdr*) ((dgram_record*)mBuf + 1) );
            }
            return; 
        } 
    } 
    fprintf( stderr, warn_no_ack, mSettings->mSock, count ); 
} 
// end write_dgram_FIN