uwtokenbus.h

Go to the documentation of this file.

//
// Copyright (c) 2021 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 UWTOKENBUS_H
#define UWTOKENBUS_H
 
#include "uwtokenbus_hdr.h"
#include <deque>
#include <mmac.h>
 
extern packet_t PT_UWTOKENBUS;
 
class UwTokenBus : public MMac
{
 
public:
    UwTokenBus();
 
    virtual ~UwTokenBus();
 
    class TimerBusIdle : public TimerHandler
    {
 
    public:
        TimerBusIdle(UwTokenBus *m)
            : TimerHandler()
        {
            assert(m != NULL);
            module = m;
        }
 
    protected:
        virtual void expire(Event *e);
        UwTokenBus *module;
    };
 
    class TimerTokenPass : public TimerHandler
    {
 
    public:
        TimerTokenPass(UwTokenBus *m)
            : TimerHandler()
        {
            assert(m != NULL);
            module = m;
        }
 
    protected:
        virtual void expire(Event *e);
        UwTokenBus *module;
    };
 
    enum UWTokenBus_STATUS { IDLE, TRANSMITTING, RECEIVING }; 
protected:
    virtual void expireBusIdle();
 
    virtual void expireTokenPass();
 
    virtual void initRing();
 
    virtual bool validToken(Packet *p) const;
 
    virtual void sendToken(int next_id);
 
    virtual void txData();
 
    virtual int normId(int id) const;
 
    virtual int nextId(int id) const;
 
    virtual int nextIdOwned(int id) const;
 
    virtual void recvFromUpperLayers(Packet *p) override;
    virtual void Phy2MacEndRx(Packet *p) override;
    virtual void Phy2MacStartRx(const Packet *p) override;
    virtual void Mac2PhyStartTx(Packet *p);
    virtual void Phy2MacEndTx(const Packet *p) override;
 
    virtual void initPkt(Packet *p);
 
    virtual int command(int argc, const char *const *argv) override;
 
    int node_id; 
    int n_nodes; 
    int last_token_id_heard = 0; 
    int last_token_id_owned = 0; 
    double max_token_hold_time; 
    double min_token_hold_time; 
    double token_rx_time; 
    int max_queue_size; 
    std::deque<Packet *> buffer; 
    UWTokenBus_STATUS rtx_status;
    bool got_token; 
    double slot_time; 
    double token_pass_timeout; 
    double bus_idle_timeout; 
    TimerTokenPass
            token_pass_timer; 
    TimerBusIdle
            bus_idle_timer; 
    int count_token_resend; 
    int count_token_regen; 
    int count_token_invalid; 
    int debug; 
    int drop_old_; 
    int checkPriority; 
    static int count_nodes; 
    static int count_token_pass_exp; 
    static int count_bus_idle_exp; 
    constexpr int
    NMOD(int n)
    {
        return ((n_nodes + (n % n_nodes)) % n_nodes);
    } 
};
 
#endif