uw-csma-aloha.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 CSMA_H
#define CSMA_H
 
#include <mmac.h>
#include <iostream>
#include <string>
#include <map>
#include <set>
#include <queue>
#include <fstream>
 
#include <mphy.h>
 
#define CSMA_DROP_REASON_WRONG_STATE                                         \
    "WST" 
#define CSMA_DROP_REASON_WRONG_RECEIVER \
    "WRCV" 
#define CSMA_DROP_REASON_UNKNOWN_TYPE \
    "UPT" 
#define CSMA_DROP_REASON_BUFFER_FULL \
    "DBF" 
#define CSMA_DROP_REASON_ERROR "ERR" 
extern packet_t PT_MMAC_ACK;
 
class CsmaAloha : public MMac
{
public:
    CsmaAloha();
    virtual ~CsmaAloha();
    virtual int command(int argc, const char *const *argv);
    virtual int crLayCommand(ClMessage *m);
 
protected:
    static const double prop_speed; 
    enum CSMA_STATUS {
        CSMA_STATE_IDLE = 1,
        CSMA_STATE_BACKOFF,
        CSMA_STATE_TX_DATA,
        CSMA_STATE_TX_ACK,
        CSMA_STATE_WAIT_ACK,
        CSMA_STATE_DATA_RX,
        CSMA_STATE_ACK_RX,
        CSMA_STATE_NOT_SET,
        CSMA_STATE_LISTEN,
        CSMA_STATE_CHK_ACK_TIMEOUT,
        CSMA_STATE_CHK_LISTEN_TIMEOUT,
        CSMA_STATE_CHK_BACKOFF_TIMEOUT,
        CSMA_STATE_RX_IDLE,
        CSMA_STATE_RX_LISTEN,
        CSMA_STATE_RX_BACKOFF,
        CSMA_STATE_RX_WAIT_ACK,
        CSMA_STATE_WRONG_PKT_RX
    };
 
    enum CSMA_REASON_STATUS {
        CSMA_REASON_DATA_PENDING,
        CSMA_REASON_DATA_RX,
        CSMA_REASON_DATA_TX,
        CSMA_REASON_ACK_TX,
        CSMA_REASON_ACK_RX,
        CSMA_REASON_BACKOFF_TIMEOUT,
        CSMA_REASON_ACK_TIMEOUT,
        CSMA_REASON_DATA_EMPTY,
        CSMA_REASON_NOT_SET,
        CSMA_REASON_MAX_TX_TRIES,
        CSMA_REASON_BACKOFF_PENDING,
        CSMA_REASON_LISTEN,
        CSMA_REASON_LISTEN_TIMEOUT,
        CSMA_REASON_LISTEN_PENDING,
        CSMA_REASON_START_RX,
        CSMA_REASON_PKT_NOT_FOR_ME,
        CSMA_REASON_WAIT_ACK_PENDING,
        CSMA_REASON_PKT_ERROR
    };
 
    enum CSMA_PKT_TYPE { CSMA_ACK_PKT = 1, CSMA_DATA_PKT, CSMA_DATAMAX_PKT };
 
    enum CSMA_ACK_MODES { CSMA_ACK_MODE = 1, CSMA_NO_ACK_MODE };
 
    enum CSMA_TIMER_STATUS {
        CSMA_IDLE = 1,
        CSMA_RUNNING,
        CSMA_FROZEN,
        CSMA_EXPIRED
    };
 
    class AlohaTimer : public TimerHandler
    {
    public:
        AlohaTimer(CsmaAloha *m)
            : TimerHandler()
            , start_time(0.0)
            , left_duration(0.0)
            , counter(0)
            , module(m)
            , timer_status(CSMA_IDLE)
        {
            assert(m != NULL);
        }
 
        virtual ~AlohaTimer()
        {
        }
 
        virtual void
        freeze()
        {
            assert(timer_status == CSMA_RUNNING);
            left_duration -= (NOW - start_time);
            if (left_duration <= 0.0)
                left_duration = module->mac2phy_delay_;
            force_cancel();
            timer_status = CSMA_FROZEN;
        }
 
        virtual void
        unFreeze()
        {
            assert(timer_status == CSMA_FROZEN);
            start_time = NOW;
            assert(left_duration > 0);
            sched(left_duration);
            timer_status = CSMA_RUNNING;
        }
 
        virtual void
        stop()
        {
            timer_status = CSMA_IDLE;
            force_cancel();
        }
 
        virtual void
        schedule(double val)
        {
            start_time = NOW;
            left_duration = val;
            timer_status = CSMA_RUNNING;
            resched(val);
        }
 
        bool
        isIdle()
        {
            return (timer_status == CSMA_IDLE);
        }
 
        bool
        isRunning()
        {
            return (timer_status == CSMA_RUNNING);
        }
 
        bool
        isExpired()
        {
            return (timer_status == CSMA_EXPIRED);
        }
 
        bool
        isFrozen()
        {
            return (timer_status == CSMA_FROZEN);
        }
 
        bool
        isActive()
        {
            return (timer_status == CSMA_FROZEN ||
                    timer_status == CSMA_RUNNING);
        }
 
        void
        resetCounter()
        {
            counter = 0;
        }
 
        void
        incrCounter()
        {
            ++counter;
        }
 
        int
        getCounter()
        {
            return counter;
        }
 
        double
        getDuration()
        {
            return left_duration;
        }
 
    protected:
        double start_time; 
        double left_duration; 
        int counter; 
        CsmaAloha *module; 
        CSMA_TIMER_STATUS timer_status; 
    };
 
    class BackOffTimer : public AlohaTimer
    {
    public:
        BackOffTimer(CsmaAloha *m)
            : AlohaTimer(m)
        {
        }
 
        virtual ~BackOffTimer()
        {
        }
 
    protected:
        virtual void expire(Event *e);
    };
 
    class AckTimer : public AlohaTimer
    {
    public:
        AckTimer(CsmaAloha *m)
            : AlohaTimer(m)
        {
        }
 
        virtual ~AckTimer()
        {
        }
 
    protected:
        virtual void expire(Event *e);
    };
 
    class ListenTimer : public AlohaTimer
    {
    public:
        ListenTimer(CsmaAloha *m)
            : AlohaTimer(m)
        {
        }
 
        virtual ~ListenTimer()
        {
        }
 
    protected:
        virtual void expire(Event *e);
    };
 
    virtual void recvFromUpperLayers(Packet *p);
    virtual void Mac2PhyStartTx(Packet *p);
    virtual void Phy2MacEndTx(const Packet *p);
    virtual void Phy2MacStartRx(const Packet *p);
    virtual void Phy2MacEndRx(Packet *p);
    virtual double computeTxTime(CSMA_PKT_TYPE type);
    virtual void initPkt(Packet *p, CSMA_PKT_TYPE pkt_type, int dest_addr = 0);
    virtual double getBackoffTime();
    virtual void txData();
    virtual void txAck(int dest_addr);
    virtual void stateIdle();
    virtual void stateRxIdle();
    virtual void stateTxData();
    virtual void stateTxAck(int dest_addr);
    virtual void stateBackoff();
    virtual void stateRxBackoff();
    virtual void stateWaitAck();
    virtual void stateRxWaitAck();
    virtual void stateListen();
    virtual void stateRxListen();
    virtual void stateCheckListenExpired();
    virtual void stateCheckAckExpired();
    virtual void stateCheckBackoffExpired();
    virtual void stateRxData(Packet *p);
    virtual void stateRxAck(Packet *p);
    virtual void stateRxPacketNotForMe(Packet *p);
    virtual void printStateInfo(double delay = 0);
    virtual void initInfo();
 
    virtual void
    refreshState(CSMA_STATUS state)
    {
        prev_prev_state = prev_state;
        prev_state = curr_state;
        curr_state = state;
    }
 
    virtual void
    refreshReason(CSMA_REASON_STATUS reason)
    {
        last_reason = reason;
    }
    virtual void exitBackoff();
 
    virtual void
    setSessionDistance(double distance)
    {
        session_distance = distance;
    }
    virtual bool keepDataPkt(int serial_number);
 
    virtual void
    incrCurrTxRounds()
    {
        curr_tx_rounds++;
    }
 
    virtual void
    resetCurrTxRounds()
    {
        curr_tx_rounds = 0;
    }
    virtual void updateRTT(double rtt);
 
    virtual double
    getRTT()
    {
        return (rttsamples > 0) ? sumrtt / rttsamples : 0;
    }
    virtual void updateAckTimeout(double rtt);
 
    virtual void
    updateLastDataIdRx(int id)
    {
        last_data_id_rx = id;
    }
 
    virtual void
    queuePop(bool flag = true)
    {
        Packet::free(Q.front());
        Q.pop();
        waitEndTime(flag);
        data_sn_queue.pop();
    }
    virtual void resetSession();
    virtual void waitForUser();
 
    // stats functions
 
    virtual int
    getRemainingPkts()
    {
        return (up_data_pkts_rx - Q.size());
    }
 
    virtual void
    incrUpperDataRx()
    {
        up_data_pkts_rx++;
    }
 
    virtual int
    getUpLayersDataPktsRx()
    {
        return up_data_pkts_rx;
    }
 
    int max_tx_tries; 
    double backoff_tuner; 
    double wait_costant; 
    int max_payload; 
    int HDR_size; 
    int ACK_size; 
    double ACK_timeout; 
    int buffer_pkts; 
    double alpha_; 
    int max_backoff_counter; 
    double listen_time; 
 
    std::queue<Packet *> Q; 
    std::queue<int>
            data_sn_queue; 
    static bool initialized; 
    static int u_pkt_id; 
    int u_data_id; 
    int last_sent_data_id; 
    bool TxActive; 
    bool RxActive; 
    bool
            session_active; 
    bool
            print_transitions; 
    bool
            has_buffer_queue; 
    double start_tx_time; 
    double srtt; 
    double sumrtt; 
    double sumrtt2; 
    int rttsamples; 
    int curr_tx_rounds; 
    int last_data_id_rx; 
    Packet *curr_data_pkt; 
    double session_distance; 
    AckTimer ack_timer; 
    BackOffTimer backoff_timer; 
    ListenTimer listen_timer; 
    CSMA_REASON_STATUS last_reason; 
    CSMA_STATUS curr_state; 
    CSMA_STATUS prev_state; 
    CSMA_STATUS prev_prev_state; 
    CSMA_ACK_MODES ack_mode; 
    static map<CSMA_STATUS, string>
            status_info; 
    static map<CSMA_REASON_STATUS, string>
            reason_info; 
    static map<CSMA_PKT_TYPE, string>
            pkt_type_info; 
    ofstream fout; 
};
 
#endif /* CSMA_H */