tfrc-sink.h

Go to the documentation of this file.

/* -*-  Mode:C++; c-basic-offset:8; tab-width:8; indent-tabs-mode:t -*- */
/*
 * Copyright(c) 1991-1997 Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. 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.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *  This product includes software developed by the Computer Systems
 *  Engineering Group at Lawrence Berkeley Laboratory.
 * 4. Neither the name of the University nor of the Laboratory may be used
 *    to endorse or promote products derived from this software without
 *    specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 THE REGENTS OR CONTRIBUTORS 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.
 *
 */

#include "agent.h"
#include "packet.h"
#include "ip.h"
#include "timer-handler.h"
#include "random.h"
#include "tfrc.h"

#define LARGE_DOUBLE 9999999999.99 
#define SAMLLFLOAT 0.0000001

/* packet status */
#define UNKNOWN 0
#define RCVD 1
#define LOST 2      // Lost, and beginning of a new loss event
#define NOT_RCVD 3  // Lost, but not the beginning of a new loss event
#define ECNLOST 4   // ECN, and beginning of a new loss event
#define ECN_RCVD 5  // Received with ECN. 

#define DEFAULT_NUMSAMPLES  8

#define WALI 1
#define EWMA 2 
#define RBPH 3
#define EBPH 4 

class TfrcSinkAgent;

class TfrcNackTimer : public TimerHandler {
public:
    TfrcNackTimer(TfrcSinkAgent *a) : TimerHandler() { 
        a_ = a; 
    }
    virtual void expire(Event *e);
protected:
    TfrcSinkAgent *a_;
};

class TfrcSinkAgent : public Agent {
    friend class TfrcNackTimer;
public:
    TfrcSinkAgent();
    void recv(Packet*, Handler*);
protected:
    void sendpkt(double);
    void nextpkt(double);
    double adjust_history(double);
    double est_loss();
    double est_thput(); 
    int command(int argc, const char*const* argv);
    void print_loss(int sample, double ave_interval);
    void print_loss_all(int *sample);
    void print_losses_all(int *losses);
    void print_count_losses_all(int *count_losses);
    int new_loss(int i, double tstamp);
    double estimate_tstamp(int before, int after, int i);

    // algo specific
    double est_loss_WALI();
    void shift_array(int *a, int sz, int defval) ;
    void shift_array(double *a, int sz, double defval) ;
    void multiply_array(double *a, int sz, double multiplier);
    void init_WALI();
    double weighted_average(int start, int end, double factor, double *m, double *w, int *sample);
    int get_sample(int oldSample, int numLosses);
    double weighted_average1(int start, int end, double factor, double *m, double *w, int *sample, int ShortIntervals, int *losses, int *count_losses);

    double est_loss_EWMA () ;
    
    double est_loss_RBPH () ;

    double est_loss_EBPH() ;

    //comman variables

    TfrcNackTimer nack_timer_;

    int psize_;     // size of received packet
    int fsize_;     // size of large TCP packet, for VoIP mode.
    double rtt_;        // rtt value reported by sender
    double tzero_;      // timeout value reported by sender
    int smooth_;        // for the smoother method for incorporating
                    //  incorporating new loss intervals
    int total_received_;    // total # of pkts rcvd by rcvr, 
                //   for statistics only
    int total_losses_;      // total # of losses, for statistics only
    int total_dropped_; // total # of drops, for statistics
    int bval_;      // value of B used in the formula
    double last_report_sent;    // when was last feedback sent
    double NumFeedback_;    // how many feedbacks per rtt
    int rcvd_since_last_report;     // # of packets rcvd since last report
    int losses_since_last_report;   // # of losses since last report
    int printLoss_;     // to print estimated loss rates
    int maxseq;         // max seq number seen
    int maxseqList;         // max seq number checked for dropped packets
    int numPkts_;       // Num non-sequential packets before
                //  inferring loss
    int numPktsSoFar_;  // Num non-sequential packets so far
    int PreciseLoss_;       // to estimate loss events more precisely
    // an option for single-RTT loss intervals
    int ShortIntervals_ ;   // For calculating loss event rates for short 
                //  loss intervals:  "0" for counting a
                // single loss; "1" for counting the actual
                // number of losses; "2" for counting at
                // most a large packet of losses.

    // these assist in keep track of incming packets and calculate flost_
    double last_timestamp_; // timestamp of last new, in-order pkt arrival.
    double last_arrival_;   // time of last new, in-order pkt arrival.
    int hsz;        // InitHistorySize_, number of pkts in history
    char *lossvec_;     // array with packet history
    double *rtvec_;     // array with time of packet arrival
    double *tsvec_;     // array with timestamp of packet
    int lastloss_round_id ; // round_id for start of loss event
    int round_id ;      // round_id of last new, in-order packet
    double lastloss;    // when last loss occured

    // WALI specific
    int numsamples ;
    int *sample;        // array with size of loss interval
    double *weights ;   // weight for loss interval
    double *mult ;      // discount factor for loss interval
    int *losses ;       // array with number of losses per loss
                //   interval
    int *count_losses ; // "1" to count losses in the loss interval
    double mult_factor_;    // most recent multiple of mult array
    int sample_count ;  // number of loss intervals
    int last_sample ;   // loss event rate estimated to here
    int init_WALI_flag; // sample arrays initialized

    // these are for "faking" history after slow start
    int loss_seen_yet;  // have we seen the first loss yet?
    int adjust_history_after_ss; // fake history after slow start? (0/1)
    int false_sample;   // by how much?
    
    int algo;       // algo for loss estimation 
    int discount ;      // emphasize most recent loss interval
                //  when it is very large
    int bytes_ ;        // For reporting on received bytes.

    // EWMA: optional variants
    double history ;
    double avg_loss_int ; 
    int loss_int ; 
    
    // RBPH, EBPH: optional variants 
    double sendrate ;
    int minlc ; 

}; 

---