uan-mac-rc-gw.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009 University of Washington
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Leonard Tracy <lentracy@gmail.com>
 */

#ifndef UAN_MAC_RC_GW_H
#define UAN_MAC_RC_GW_H

#include "uan-mac.h"
#include "ns3/mac8-address.h"

#include "ns3/nstime.h"
#include "ns3/traced-callback.h"




#include <set>
#include <map>

namespace ns3 {

class UanTxMode;

class UanMacRcGw : public UanMac
{
public:
  UanMacRcGw ();           
  virtual ~UanMacRcGw ();  

  static TypeId GetTypeId (void);

  // Inherited methods
  virtual bool Enqueue (Ptr<Packet> pkt, uint16_t protocolNumber, const Address &dest);
  virtual void SetForwardUpCb (Callback<void, Ptr<Packet>, uint16_t, const Mac8Address&> cb);
  virtual void AttachPhy (Ptr<UanPhy> phy);
  virtual void Clear (void);
  int64_t AssignStreams (int64_t stream);

  typedef void (* CycleCallback)
    (Time now, Time delay, uint32_t numRts, uint32_t totalBytes,
     double secs, uint32_t ctlRate, double actualX);

  
private:
  enum State {
    IDLE,     
    INCYCLE,  
    CTSING    
  };
  State m_state;  

  struct Request
  {
    uint8_t numFrames;  
    uint8_t frameNo;    
    uint8_t retryNo;    
    uint16_t length;    
    Time rxTime;        
  };

  struct AckData
  {
    uint8_t frameNo;    
    std::set<uint8_t> rxFrames;  
    uint8_t expFrames;  
  };
  Callback<void, Ptr<Packet>, uint16_t, const Mac8Address&> m_forwardUpCb;
  
  Ptr<UanPhy> m_phy;            
  Mac8Address m_address;         
  Time m_maxDelta;              
  Time m_sifs;                  
  uint32_t m_maxRes;            
  uint32_t m_numRates;          
  uint32_t m_rtsSize;           
  uint32_t m_ctsSizeN;          
  uint32_t m_ctsSizeG;          
  uint32_t m_ackSize;           
  uint16_t m_currentRetryRate;  
  uint32_t m_currentRateNum;    
  uint32_t m_numNodes;          
  uint32_t m_totalRate;         
  uint32_t m_rateStep;          
  uint32_t m_frameSize;         

  double m_minRetryRate;        
  double m_retryStep;           

  std::map<Mac8Address, Time> m_propDelay;

  std::map<Mac8Address, AckData> m_ackData;

  std::map<Mac8Address, Request> m_requests;
  std::set<std::pair<Time, Mac8Address> > m_sortedRes;

  bool m_cleared;

  TracedCallback<Ptr<const Packet>, UanTxMode > m_rxLogger;

  TracedCallback<Time, Time, uint32_t, uint32_t, double, uint32_t, double> m_cycleLogger;

  void ReceivePacket (Ptr<Packet> pkt, double sinr, UanTxMode mode);

  void StartCycle (void);
  void EndCycle (void);
  void SendPacket (Ptr<Packet> pkt, uint32_t rate);
  void CycleStarted (void);
  void ReceiveError (Ptr<Packet> pkt, double sinr);

  // Stuff for computing exp throughput
   double ComputeAlpha (uint32_t totalFrames, uint32_t totalBytes, uint32_t n, uint32_t a, double deltaK);
  std::vector<double>  GetExpPdk (void);
  double ComputeExpS (uint32_t a, uint32_t ld, std::vector<double> exppdk);
  double ComputeExpS (uint32_t a, uint32_t ld);
  uint32_t CompExpMinIndex (uint32_t n, uint32_t k);
  double ComputePiK (uint32_t a, uint32_t n, uint32_t k);
  double ComputeExpBOverA (uint32_t n, uint32_t a, uint32_t ldlh, std::vector<double> deltaK);
  uint64_t NchooseK (uint32_t n, uint32_t k);
  uint32_t FindOptA (void);
protected:
  virtual void DoDispose ();

};  // class UanMacRcGw

} // namespace ns3

#endif /* UAN_MAC_RC_GW_H */