uw-csma-aloha-trigger-node.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 UW_CS_ALOHA_TRIG_NODE_H
#define UW_CS_ALOHA_TRIG_NODE_H
 
#include <climits>
#include <cmath>
#include <fstream>
#include <iomanip>
#include <iostream>
#include <mac.h>
#include <map>
#include <mmac.h>
#include <mphy.h>
#include <queue>
#include <rng.h>
#include <set>
#include <string>
 
#define UW_CS_ALOHA_TRIG_NODE_DROP_REASON_BUFFER_FULL \
    "DBF" 
#define UW_CS_ALOHA_TRIG_NODE_DROP_REASON_ERROR "ERR" 
extern packet_t PT_MMAC_TRIGGER;
 
class UwCsmaAloha_Trigger_NODE : public MMac
{
public:
    UwCsmaAloha_Trigger_NODE();
    virtual ~UwCsmaAloha_Trigger_NODE();
    virtual int command(int argc, const char *const *argv);
    virtual int crLayCommand(ClMessage *m);
 
protected:
    static const double prop_speed; 
    enum UW_CS_ALOHA_TRIG_NODE_STATUS {
        UW_CS_ALOHA_TRIG_NODE_STATE_IDLE = 1,
        UW_CS_ALOHA_TRIG_NODE_STATE_TX_DATA,
        UW_CS_ALOHA_TRIG_NODE_STATE_DATA_RX,
        UW_CS_ALOHA_TRIG_NODE_STATE_NOT_SET,
        UW_CS_ALOHA_TRIG_NODE_STATE_LISTEN,
        UW_CS_ALOHA_TRIG_NODE_STATE_CHK_LISTEN_TIMEOUT,
        UW_CS_ALOHA_TRIG_NODE_STATE_RX_IDLE,
        UW_CS_ALOHA_TRIG_NODE_STATE_RX_LISTEN,
        UW_CS_ALOHA_TRIG_NODE_STATE_WRONG_PKT_RX,
        UW_CS_ALOHA_TRIG_NODE_STATE_RX_TRIGGER
    };
 
    enum UW_CS_ALOHA_TRIG_NODE_REASON_STATUS {
        UW_CS_ALOHA_TRIG_NODE_REASON_DATA_PENDING,
        UW_CS_ALOHA_TRIG_NODE_REASON_DATA_RX,
        UW_CS_ALOHA_TRIG_NODE_REASON_DATA_TX,
        UW_CS_ALOHA_TRIG_NODE_REASON_DATA_EMPTY,
        UW_CS_ALOHA_TRIG_NODE_REASON_NOT_SET,
        UW_CS_ALOHA_TRIG_NODE_REASON_LISTEN,
        UW_CS_ALOHA_TRIG_NODE_REASON_LISTEN_TIMEOUT,
        UW_CS_ALOHA_TRIG_NODE_REASON_LISTEN_PENDING,
        UW_CS_ALOHA_TRIG_NODE_REASON_START_RX,
        UW_CS_ALOHA_TRIG_NODE_REASON_PKT_NOT_FOR_ME,
        UW_CS_ALOHA_TRIG_NODE_REASON_PKT_ERROR,
        UW_CS_ALOHA_TRIG_NODE_REASON_LISTEN_AFTER_TRIGGER,
        UW_CS_ALOHA_TRIG_NODE_REASON_TRIGGER_RX
    };
 
    enum UW_CS_ALOHA_TRIG_NODE_TIMER_STATUS {
        UW_CS_ALOHA_TRIG_NODE_IDLE = 1,
        UW_CS_ALOHA_TRIG_NODE_RUNNING,
        UW_CS_ALOHA_TRIG_NODE_FROZEN,
        UW_CS_ALOHA_TRIG_NODE_EXPIRED
    };
 
    class Csma_Aloha_Triggered_Timer : public TimerHandler
    {
    public:
        Csma_Aloha_Triggered_Timer(UwCsmaAloha_Trigger_NODE *m)
            : TimerHandler()
            , start_time(0.0)
            , left_duration(0.0)
            , counter(0)
            , module(m)
            , timer_status(UW_CS_ALOHA_TRIG_NODE_IDLE)
        {
            assert(m != NULL);
        }
 
        virtual ~Csma_Aloha_Triggered_Timer()
        {
        }
 
        virtual void
        freeze()
        {
            assert(timer_status == UW_CS_ALOHA_TRIG_NODE_RUNNING);
            left_duration -= (NOW - start_time);
            if (left_duration <= 0.0)
                left_duration = module->mac2phy_delay_;
            force_cancel();
            timer_status = UW_CS_ALOHA_TRIG_NODE_FROZEN;
        }
 
        virtual void
        unFreeze()
        {
            assert(timer_status == UW_CS_ALOHA_TRIG_NODE_FROZEN);
            start_time = NOW;
            assert(left_duration > 0);
            sched(left_duration);
            timer_status = UW_CS_ALOHA_TRIG_NODE_RUNNING;
        }
 
        virtual void
        stop()
        {
            timer_status = UW_CS_ALOHA_TRIG_NODE_IDLE;
            force_cancel();
        }
 
        virtual void
        schedule(double val)
        {
            start_time = NOW;
            left_duration = val;
            timer_status = UW_CS_ALOHA_TRIG_NODE_RUNNING;
            resched(val);
        }
 
        bool
        isIdle()
        {
            return (timer_status == UW_CS_ALOHA_TRIG_NODE_IDLE);
        }
 
        bool
        isRunning()
        {
            return (timer_status == UW_CS_ALOHA_TRIG_NODE_RUNNING);
        }
 
        bool
        isExpired()
        {
            return (timer_status == UW_CS_ALOHA_TRIG_NODE_EXPIRED);
        }
 
        bool
        isFrozen()
        {
            return (timer_status == UW_CS_ALOHA_TRIG_NODE_FROZEN);
        }
 
        bool
        isActive()
        {
            return (timer_status == UW_CS_ALOHA_TRIG_NODE_FROZEN ||
                    timer_status == UW_CS_ALOHA_TRIG_NODE_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; 
        UwCsmaAloha_Trigger_NODE *module; 
        UW_CS_ALOHA_TRIG_NODE_TIMER_STATUS timer_status; 
    };
 
    class ListenTimer : public Csma_Aloha_Triggered_Timer
    {
    public:
        ListenTimer(UwCsmaAloha_Trigger_NODE *m)
            : Csma_Aloha_Triggered_Timer(m)
        {
        }
 
        virtual ~ListenTimer()
        {
        }
 
    protected:
        virtual void expire(Event *e);
    };
 
    class TransmissionTimer : public Csma_Aloha_Triggered_Timer
    {
    public:
        TransmissionTimer(UwCsmaAloha_Trigger_NODE *m)
            : Csma_Aloha_Triggered_Timer(m)
        {
        }
 
        virtual ~TransmissionTimer()
        {
        }
 
    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 void initPkt(Packet *p);
    virtual void txData();
 
    virtual void stateIdle();
    virtual void stateRxIdle();
    virtual void stateTxData();
    virtual void stateListen();
    virtual void stateRxListen();
    virtual void stateRxTrigger(Packet *p);
 
    virtual void stateCheckListenExpired();
    virtual void stateCheckTxTimerExpired();
    virtual void stateRxData(Packet *p);
    virtual void stateRxPacketNotForMe(Packet *p);
    virtual void initInfo();
 
    virtual void
    refreshState(UW_CS_ALOHA_TRIG_NODE_STATUS state)
    {
        prev_prev_state = prev_state;
        prev_state = curr_state;
        curr_state = state;
    }
 
    virtual void
    refreshReason(UW_CS_ALOHA_TRIG_NODE_REASON_STATUS reason)
    {
        last_reason = reason;
    }
 
    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 waitForUser();
 
    // stats functions
 
    virtual int
    getRemainingPkts()
    {
        return (up_data_pkts_rx - Q.size());
    }
 
    virtual void
    incrUpperDataRx()
    {
        up_data_pkts_rx++;
    }
 
    ListenTimer listen_timer;
 
    TransmissionTimer tx_timer;
 
    double wait_costant; 
    int max_payload; 
    int HDR_size; 
    int buffer_pkts; 
    double listen_time; 
    int tx_timer_duration; 
 
    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; 
    Packet *curr_data_pkt; 
    int last_data_id_rx; 
    bool has_buffer_queue; 
    bool can_transmit; 
    static map<UW_CS_ALOHA_TRIG_NODE_STATUS, string>
            status_info; 
    static map<UW_CS_ALOHA_TRIG_NODE_REASON_STATUS, string>
            reason_info; 
    UW_CS_ALOHA_TRIG_NODE_STATUS
    curr_state; 
    UW_CS_ALOHA_TRIG_NODE_STATUS
    prev_state; 
    UW_CS_ALOHA_TRIG_NODE_STATUS
    prev_prev_state; 
    UW_CS_ALOHA_TRIG_NODE_REASON_STATUS
    last_reason; 
    ofstream fout; 
};
 
#endif