DESERT_Addons/uwmphy_modem/uwmphy_modem.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 UWMPHY_MODEM_H
#define UWMPHY_MODEM_H
 
#include "uwmdriver.h"
#include <uwal.h>
#include <hdr-uwal.h>
#include <uwip-module.h>
#include <mac.h>
#include <mphy.h>
 
#include <stdlib.h>
#include <iostream>
#include <stdio.h>
#include <fstream>
#include <string.h>
#include <errno.h>
#include <cstring>
#include <sstream>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <unistd.h>
#include <cmath>
#include <time.h>
 
#define _MTBL                                                                  \
    5 
#define MIN_MODEM_QUEUE_LENGTH 2
#define MAX_MODEM_QUEUE_LENGTH 30
 
 
 
// Forward declaration
class DropTimer;
class CheckTimer;
 
class UWMPhy_modem : public MPhy
{
    friend class CheckTimer;
 
    friend class DropTimer;
 
public:
    UWMPhy_modem(std::string);
 
    ~UWMPhy_modem();
 
    virtual void recv(Packet *);
 
    virtual int command(int, const char *const *);
 
    virtual int recvSyncClMsg(ClMessage *m) = 0;
    inline int
    getID()
    {
        return ID;
    }
    inline double
    getPeriod()
    {
        return period;
    }
 
    std::string
    getPathToDevice()
    {
        return pToDevice;
    }
 
    uint
    getQueueLength()
    {
        return queue_length;
    }
 
    int
    getDebug()
    {
        return debug_;
    }
    std::string
    getLogFile()
    {
        return logFile;
    }
 
    log_level_t
    getLogLevel()
    {
        return (log_level_t) loglevel_;
    }
 
    inline unsigned long int
    getEpoch()
    {
        return time(NULL);
    }
 
    void updatePktRx(Packet *);
 
protected:
    CheckTimer *pcheckTmr; 
    UWMdriver *pmDriver; 
    DropTimer *pDropTimer;
 
    int ID; 
    double period; 
    Packet *modemTxBuff[_MTBL]; 
    int t; 
    Packet *PktRx; 
    std::string pToDevice; 
    int debug_; 
    std::ofstream outLog; 
    std::string logFile; 
    char *log_suffix; 
    int loglevel_; 
    int SetModemID; 
    uint queue_length;
 
    void setConnections(CheckTimer *, UWMdriver *, DropTimer *);
 
    virtual void start();
 
    virtual void stop();
 
    virtual modem_state_t check_modem() = 0;
 
    virtual void startTx(Packet *);
 
    virtual void endTx(Packet *);
 
    virtual void startRx(Packet *);
 
    virtual void endRx(Packet *);
 
    Packet *popTxBuff();
 
    virtual inline double
    getTxDuration(Packet *p)
    {
    }
 
    virtual inline int
    getModulationType(Packet *p)
    {
    }
};
 
class CheckTimer : public TimerHandler
{
public:
    CheckTimer(UWMPhy_modem *pmModem_)
        : TimerHandler()
    {
        pmModem = pmModem_;
        if (pmModem->getDebug() >= 2) {
            cout << this
                 << ": in constructor of CheckTimer which points to modem: "
                 << pmModem << "\n";
        }
    }
 
protected:
    virtual void expire(Event *e);
 
    UWMPhy_modem *pmModem; 
};
 
class DropTimer : public TimerHandler
{
public:
    DropTimer(UWMPhy_modem *pModem_)
        : TimerHandler()
    {
        pModem = pModem_;
    }
 
protected:
    virtual void expire(Event *e);
    UWMPhy_modem *pModem;
};
 
#endif /* UWMPHY_MODEM_H */