uw-ofdm-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 UWOFDMALOHA_H_
#define UWOFDMALOHA_H_
 
#include <fstream>
#include <iostream>
#include <map>
#include <mmac.h>
#include <queue>
#include <set>
#include <string>
 
#include "uwofdmphy_hdr.h"
#include <mphy.h>
 
#define UWOFDMALOHA_DROP_REASON_WRONG_STATE "WST"
#define UWOFDMALOHA_DROP_REASON_WRONG_RECEIVER "WRCV"
#define UWOFDMALOHA_DROP_REASON_UNKNOWN_TYPE "UPT"
#define UWOFDMALOHA_DROP_REASON_BUFFER_FULL "DBF"
#define UWOFDMALOHA_DROP_REASON_ERROR "ERR"
 
extern packet_t PT_MMAC_ACK;
 
typedef int pktSeqNum;
 
class UWOFDMAloha : public MMac
{
 
public:
    UWOFDMAloha();
 
    virtual ~UWOFDMAloha();
 
    virtual int command(int argc, const char *const *argv);
 
    void init_macofdm_node(int subCarNum, double subCarSize, int ctrl_subCar,
            string modulation);
 
protected:
    enum UWOFDMALOHA_STATUS {
        UWOFDMALOHA_STATE_IDLE = 1,
        UWOFDMALOHA_STATE_BACKOFF,
        UWOFDMALOHA_STATE_TX_DATA,
        UWOFDMALOHA_STATE_TX_ACK,
        UWOFDMALOHA_STATE_WAIT_ACK,
        UWOFDMALOHA_STATE_DATA_RX,
        UWOFDMALOHA_STATE_ACK_RX,
        UWOFDMALOHA_STATE_NOT_SET,
        UWOFDMALOHA_STATE_CHK_ACK_TIMEOUT,
        UWOFDMALOHA_STATE_RX_IDLE,
        UWOFDMALOHA_STATE_RX_WAIT_ACK,
        UWOFDMALOHA_STATE_CHK_BACKOFF_TIMEOUT,
        UWOFDMALOHA_STATE_RX_BACKOFF,
        UWOFDMALOHA_STATE_WRONG_PKT_RX,
        UWOFDMALOHA_STATE_RX_IN_PROGRESS,
        UWOFDMALOHA_STATE_MULTIPLE_RX_IN_PROGRESS,
    };
 
    enum UWOFDMALOHA_REASON_STATUS {
        UWOFDMALOHA_REASON_DATA_PENDING,
        UWOFDMALOHA_REASON_DATA_RX,
        UWOFDMALOHA_REASON_DATA_TX,
        UWOFDMALOHA_REASON_ACK_TX,
        UWOFDMALOHA_REASON_ACK_RX,
        UWOFDMALOHA_REASON_ACK_TIMEOUT,
        UWOFDMALOHA_REASON_DATA_EMPTY,
        UWOFDMALOHA_REASON_NOT_SET,
        UWOFDMALOHA_REASON_MAX_TX_TRIES,
        UWOFDMALOHA_REASON_START_RX,
        UWOFDMALOHA_REASON_PKT_NOT_FOR_ME,
        UWOFDMALOHA_REASON_WAIT_ACK_PENDING,
        UWOFDMALOHA_REASON_PKT_ERROR,
        UWOFDMALOHA_REASON_BACKOFF_TIMEOUT,
        UWOFDMALOHA_REASON_BACKOFF_PENDING,
        UWOFDMALOHA_REASON_PKT_RECEIVING,
    };
 
    enum UWOFDMALOHA_PKT_TYPE {
        UWOFDMALOHA_ACK_PKT = 1,
        UWOFDMALOHA_DATA_PKT,
        UWOFDMALOHA_DATAMAX_PKT
    };
 
    enum UWOFDMALOHA_ACK_MODES {
        UWOFDMALOHA_ACK_MODE = 1,
        UWOFDMALOHA_NO_ACK_MODE
    };
 
    enum UWOFDMALOHA_TIMER_STATUS {
        UWOFDMALOHA_IDLE = 1,
        UWOFDMALOHA_RUNNING,
        UWOFDMALOHA_FROZEN,
        UWOFDMALOHA_EXPIRED
    };
 
    class UWOFDMAlohaTimer : public TimerHandler
    {
 
    public:
        UWOFDMAlohaTimer(UWOFDMAloha *m)
            : TimerHandler()
            , start_time(0.0)
            , left_duration(0.0)
            , counter(0)
            , module(m)
            , timer_status(UWOFDMALOHA_IDLE)
        {
            assert(m != NULL);
        }
 
        virtual ~UWOFDMAlohaTimer()
        {
        }
 
        virtual void
        freeze()
        {
            assert(timer_status == UWOFDMALOHA_RUNNING);
            left_duration -= (NOW - start_time);
            if (left_duration <= 0.0)
                left_duration = module->mac2phy_delay_;
            force_cancel();
            timer_status = UWOFDMALOHA_FROZEN;
        }
        virtual void
        unFreeze()
        {
            assert(timer_status == UWOFDMALOHA_FROZEN);
            start_time = NOW;
            assert(left_duration > 0);
            sched(left_duration);
            timer_status = UWOFDMALOHA_RUNNING;
        }
 
        virtual void
        stop()
        {
            timer_status = UWOFDMALOHA_IDLE;
            force_cancel();
        }
 
        virtual void
        schedule(double val)
        {
            start_time = NOW;
            left_duration = val;
            timer_status = UWOFDMALOHA_RUNNING;
            resched(val);
        }
 
        bool
        isIdle()
        {
            return (timer_status == UWOFDMALOHA_IDLE);
        }
 
        bool
        isRunning()
        {
            return (timer_status == UWOFDMALOHA_RUNNING);
        }
 
        bool
        isExpired()
        {
            return (timer_status == UWOFDMALOHA_EXPIRED);
        }
 
        bool
        isFrozen()
        {
            return (timer_status == UWOFDMALOHA_FROZEN);
        }
 
        bool
        isActive()
        {
            return (timer_status == UWOFDMALOHA_FROZEN ||
                    timer_status == UWOFDMALOHA_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; 
        UWOFDMAloha *module; 
        UWOFDMALOHA_TIMER_STATUS
                timer_status; 
    };
 
    class AckTimer : public UWOFDMAlohaTimer
    {
 
    public:
        AckTimer(UWOFDMAloha *m)
            : UWOFDMAlohaTimer(m)
        {
        }
 
        virtual ~AckTimer()
        {
        }
 
    protected:
        virtual void expire(Event *e);
    };
 
    class BackOffTimer : public UWOFDMAlohaTimer
    {
 
    public:
        BackOffTimer(UWOFDMAloha *m)
            : UWOFDMAlohaTimer(m)
        {
        }
 
        virtual ~BackOffTimer()
        {
        }
 
    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(UWOFDMALOHA_PKT_TYPE type);
 
    virtual void initPkt(
            Packet *p, UWOFDMALOHA_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 stateWaitAck();
 
    virtual void stateRxWaitAck();
 
    virtual void stateBackoff();
 
    virtual void stateRxBackoff();
 
    virtual void stateCheckAckExpired();
 
    virtual void stateCheckBackoffExpired();
 
    virtual void stateRxData(Packet *p);
 
    virtual void stateRxAck(Packet *p);
 
    virtual void exitBackoff();
 
    virtual void printStateInfo(double delay = 0);
 
    virtual void initInfo();
 
    virtual void
    refreshState(UWOFDMALOHA_STATUS state)
    {
        prev_prev_state = prev_state;
        prev_state = curr_state;
        curr_state = state;
    }
 
    virtual void
    refreshReason(UWOFDMALOHA_REASON_STATUS reason)
    {
        last_reason = reason;
    }
 
    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;
    }
 
    inline int
    getPktSeqNum(Packet *p)
    {
        int seq_num;
        hdr_cmn *ch = hdr_cmn::access(p);
        seq_num = ch->uid();
        return seq_num;
    }
 
    inline void
    putPktInQueue(Packet *p)
    {
        mapPacket.insert(pair<pktSeqNum, Packet *>(getPktSeqNum(p), p));
        if (uwofdmaloha_debug)
            std::cout << "MAC " << addr << "putPktInQueue packet "
                      << getPktSeqNum(p) << std::endl;
    }
 
    inline void
    eraseItemFromPktQueue(int seq_num)
    {
        map<pktSeqNum, Packet *>::iterator it_p;
        it_p = mapPacket.find(seq_num);
        if (uwofdmaloha_debug)
            std::cout << "MAC " << addr << "eraseItemFromPktQueue packet "
                      << seq_num << std::endl;
        Packet::free((*it_p).second);
        if (uwofdmaloha_debug)
            std::cout << "eraseItemFromPktQueue freed second " << std::endl;
        mapPacket.erase((*it_p).first);
        if (uwofdmaloha_debug)
            std::cout << "eraseItemFromPktQueue erased first " << std::endl;
    }
 
    inline void
    putAckTimerInMap(int seq_num)
    {
        mapAckTimer.insert(pair<pktSeqNum, AckTimer>(seq_num, ack_timer));
    }
 
    inline void
    eraseItemFrommapAckTimer(int seq_num)
    {
        map<pktSeqNum, AckTimer>::iterator it_a;
        it_a = mapAckTimer.find(seq_num);
        mapAckTimer.erase((*it_a).first);
    }
 
    virtual int
    getRemainingPkts()
    {
        return (up_data_pkts_rx - mapPacket.size());
    }
 
    virtual void
    incrUpperDataRx()
    {
        up_data_pkts_rx++;
    }
 
    inline int
    getUpLayersDataPktsRx()
    {
        return up_data_pkts_rx;
    }
 
    inline void
    displayCarriers(Packet *p)
    {
        hdr_OFDM *ofdmph = HDR_OFDM(p);
 
        std::cout << NOW << "UwOFDMAloha (" << addr << ")::displayCarriers";
 
        for (int i = 0; i < mac_ncarriers; i++)
            std::cout << " car[" << i << "] = " << ofdmph->carriers[i];
 
        std::cout << " " << std::endl;
        return;
    }
 
    inline void
    addInvalidCarriers(int c)
    {
        nouse_carriers.push_back(c);
    }
 
    int max_tx_tries; 
    double wait_constant; 
    double backoff_tuner; 
    int max_payload; 
    int HDR_size; 
    int ACK_size; 
    double ACK_timeout; 
    int buffer_pkts; 
    double alpha_; 
    double max_backoff_counter; 
    int uwofdmaloha_debug; 
 
    std::vector<string> mac_carMod; // Vector with carriers modulations
    std::vector<int> mac_carVec; // Vector with carriers used/not used
    int mac_ncarriers; // number of subcarriers
    double mac_carrierSize; // size of each subcarrier
    int ctrl_car; // number of control subcarriers
    bool AckInBand = true; // if ACK uses full bandwidth
    bool alohaOnCarrier = false;
 
    int waitforpktnum = 0; // sequence number of the next expected packet
 
    int n_receptions; // number of receptions at a certain moment
 
    std::vector<Packet *> pkt_rcv_queue; // queue of packets being received
 
    std::vector<int>
            nouse_carriers; // vectors of carriers that should not be used
    bool disturbanceNode; // true if this is a disturbing node, not part of the
                          // main network
 
    static bool initialized; 
    int last_sent_data_id; 
    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; 
    int recv_data_id; 
    Packet *curr_data_pkt; 
    int txsn; 
    static const double prop_speed; 
    AckTimer ack_timer; 
    BackOffTimer backoff_timer; 
    UWOFDMALOHA_REASON_STATUS
    last_reason; 
    UWOFDMALOHA_STATUS curr_state; 
    UWOFDMALOHA_STATUS
    prev_state; 
    UWOFDMALOHA_STATUS prev_prev_state; 
    UWOFDMALOHA_ACK_MODES
    ack_mode; 
    static map<UWOFDMALOHA_STATUS, string> status_info; 
    static map<UWOFDMALOHA_REASON_STATUS, string>
            reason_info; 
    static map<UWOFDMALOHA_PKT_TYPE, string>
            pkt_type_info; 
    map<pktSeqNum, Packet *>
            mapPacket; 
    map<pktSeqNum, AckTimer> mapAckTimer; 
    ofstream fout; 
};
 
#endif /* UWUWOFDMALOHA_H_ */