uwcbr-module.h

Go to the documentation of this file.

//
// Copyright (c) 2017 Regents of the SIGNET lab, University of Padova.
// 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. Neither the name of the University of Padova (SIGNET lab) 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 THE COPYRIGHT OWNER 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.
//
 
#ifndef UWCBR_MODULE_H
#define UWCBR_MODULE_H
 
#include <climits>
#include <module.h>
#include <uwip-module.h>
#include <uwudp-module.h>
 
#define UWCBR_DROP_REASON_UNKNOWN_TYPE \
    "UKT" 
#define UWCBR_DROP_REASON_OUT_OF_SEQUENCE \
    "OOS" 
#define UWCBR_DROP_REASON_DUPLICATED_PACKET \
    "DPK" 
#define HDR_UWCBR(p) (hdr_uwcbr::access(p))
 
extern packet_t PT_UWCBR;
 
typedef struct hdr_uwcbr {
    uint16_t sn_; 
    float rftt_; 
    bool rftt_valid_; 
    char priority_; 
    uint16_t traffic_type_; 
    static int offset_; 
    static int &
    offset()
    {
        return offset_;
    }
 
    static struct hdr_uwcbr *
    access(const Packet *p)
    {
        return (struct hdr_uwcbr *) p->access(offset_);
    }
 
    uint16_t &
    sn()
    {
        return sn_;
    }
 
    bool &
    rftt_valid()
    {
        return rftt_valid_;
    }
 
    char &
    priority()
    {
        return priority_;
    }
 
    float &
    rftt()
    {
        return (rftt_);
    }
 
    uint16_t &
    traffic_type()
    {
        return (traffic_type_);
    }
} hdr_uwcbr;
 
class UwCbrModule;
 
class UwSendTimer : public TimerHandler
{
public:
    UwSendTimer(UwCbrModule *m)
        : TimerHandler()
    {
        module = m;
    }
 
protected:
    virtual void expire(Event *e);
    UwCbrModule *module;
};
 
class UwCbrModule : public Module
{
    friend class UwSendTimer;
 
public:
    UwCbrModule();
 
    virtual ~UwCbrModule() = default;
 
    virtual void recv(Packet *) override;
 
    virtual void recv(Packet *p, Handler *h) override;
 
    virtual int command(int argc, const char *const *argv) override;
 
    virtual double GetRTT() const;
 
    virtual double GetFTT() const;
 
    virtual double GetTxTime() const;
 
    virtual double GetPER() const;
 
    virtual double GetTHR() const;
 
    virtual double GetRTTstd() const;
 
    virtual double GetFTTstd() const;
 
    virtual void resetStats();
 
    void
    printIdsPkts() const
    {
        std::cout << "UWCBR packets IDs:" << std::endl;
        std::cout << "PT_UWCBR: \t\t" << PT_UWCBR << std::endl;
    }
 
protected:
    static int uidcnt_; 
    uint16_t dstPort_; 
    std::string log_suffix; 
    nsaddr_t dstAddr_; 
    char priority_; 
    std::ofstream tracefile;
    std::string tracefilename;
 
    bool *sn_check; 
    int PoissonTraffic_; 
    int debug_; 
    int drop_out_of_order_; 
    uint traffic_type_; 
    UwSendTimer sendTmr_; 
    int txsn; 
    int hrsn; 
    int pkts_recv; 
    int pkts_ooseq; 
    int pkts_lost; 
    int pkts_invalid; 
    int pkts_last_reset; 
    int cnt; 
    double rftt; 
    double srtt; 
    double sftt; 
    double lrtime; 
    double sthr; 
    double period_; 
    int pktSize_; 
    /* Cumulative statistics */
    double sumrtt; 
    double sumrtt2; 
    int rttsamples; 
    double sumftt; 
    double sumftt2; 
    int fttsamples; 
    double sumtxtimes = 0; 
    double sumbytes; 
    double sumdt; 
    uint32_t esn; 
    int tracefile_enabler_; 
    virtual void initPkt(Packet *p);
 
    virtual void sendPkt();
 
    virtual void sendPktLowPriority();
 
    virtual void sendPktHighPriority();
 
    virtual void transmit();
 
    virtual void start();
 
    virtual void stop();
 
    virtual void updateRTT(const double &);
 
    virtual void updateFTT(const double &);
 
    virtual void updateThroughput(const int &, const double &);
 
    virtual void incrPktLost(const int &);
 
    virtual void incrPktRecv();
 
    virtual void incrPktOoseq();
 
    virtual void incrPktInvalid();
 
    virtual double getTimeBeforeNextPkt();
 
    virtual void printReceivedPacket(Packet *p);
 
    static int
    getCbrHeaderSize()
    {
        return sizeof(hdr_uwcbr);
    }
};
 
#endif // UWCBR_MODULE_H