A Discrete-Event Network Simulator
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 University of Washington
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Leonard Tracy <lentracy@gmail.com>
19  */
21 #ifndef UAN_MAC_RC_GW_H
22 #define UAN_MAC_RC_GW_H
24 #include "uan-mac.h"
25 #include "ns3/mac8-address.h"
27 #include "ns3/nstime.h"
28 #include "ns3/traced-callback.h"
33 #include <set>
34 #include <map>
36 namespace ns3 {
38 class UanTxMode;
57 class UanMacRcGw : public UanMac
58 {
59 public:
60  UanMacRcGw ();
61  virtual ~UanMacRcGw ();
67  static TypeId GetTypeId (void);
69  // Inherited methods
70  virtual bool Enqueue (Ptr<Packet> pkt, uint16_t protocolNumber, const Address &dest);
71  virtual void SetForwardUpCb (Callback<void, Ptr<Packet>, uint16_t, const Mac8Address&> cb);
72  virtual void AttachPhy (Ptr<UanPhy> phy);
73  virtual void Clear (void);
74  int64_t AssignStreams (int64_t stream);
88  typedef void (* CycleCallback)
89  (Time now, Time delay, uint32_t numRts, uint32_t totalBytes,
90  double secs, uint32_t ctlRate, double actualX);
93 private:
95  enum State {
96  IDLE,
99  };
106  struct Request
107  {
108  uint8_t numFrames;
109  uint8_t frameNo;
110  uint8_t retryNo;
111  uint16_t length;
113  };
119  struct AckData
120  {
121  uint8_t frameNo;
122  std::set<uint8_t> rxFrames;
123  uint8_t expFrames;
124  };
131  uint32_t m_maxRes;
132  uint32_t m_numRates;
133  uint32_t m_rtsSize;
134  uint32_t m_ctsSizeN;
135  uint32_t m_ctsSizeG;
136  uint32_t m_ackSize;
138  uint32_t m_currentRateNum;
139  uint32_t m_numNodes;
140  uint32_t m_totalRate;
141  uint32_t m_rateStep;
142  uint32_t m_frameSize;
144  double m_minRetryRate;
145  double m_retryStep;
148  std::map<Mac8Address, Time> m_propDelay;
151  std::map<Mac8Address, AckData> m_ackData;
154  std::map<Mac8Address, Request> m_requests;
156  std::set<std::pair<Time, Mac8Address> > m_sortedRes;
159  bool m_cleared;
185  void ReceivePacket (Ptr<Packet> pkt, double sinr, UanTxMode mode);
188  void StartCycle (void);
190  void EndCycle (void);
197  void SendPacket (Ptr<Packet> pkt, uint32_t rate);
199  void CycleStarted (void);
206  void ReceiveError (Ptr<Packet> pkt, double sinr);
208  // Stuff for computing exp throughput
219  double ComputeAlpha (uint32_t totalFrames, uint32_t totalBytes, uint32_t n, uint32_t a, double deltaK);
225  std::vector<double> GetExpPdk (void);
235  double ComputeExpS (uint32_t a, uint32_t ld, std::vector<double> exppdk);
243  double ComputeExpS (uint32_t a, uint32_t ld);
251  uint32_t CompExpMinIndex (uint32_t n, uint32_t k);
260  double ComputePiK (uint32_t a, uint32_t n, uint32_t k);
270  double ComputeExpBOverA (uint32_t n, uint32_t a, uint32_t ldlh, std::vector<double> deltaK);
278  uint64_t NchooseK (uint32_t n, uint32_t k);
284  uint32_t FindOptA (void);
285 protected:
286  virtual void DoDispose ();
288 }; // class UanMacRcGw
290 } // namespace ns3
292 #endif /* UAN_MAC_RC_GW_H */
double m_retryStep
Retry rate increment.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
virtual void AttachPhy(Ptr< UanPhy > phy)
Attach PHY layer to this MAC.
Time rxTime
Time request received.
uint32_t CompExpMinIndex(uint32_t n, uint32_t k)
Index to the k&#39;th expected delay among n nodes.
Callback template class.
Definition: callback.h:1278
TracedCallback< Time, Time, uint32_t, uint32_t, double, uint32_t, double > m_cycleLogger
A packet was destined for and received at this MAC layer.
uint32_t m_ctsSizeG
Size of UanHeaderCommon and UanHeaderRcCtsGlobal.
bool m_cleared
Flag when we&#39;ve been cleared.
std::map< Mac8Address, Request > m_requests
Request for each node.
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model...
std::set< std::pair< Time, Mac8Address > > m_sortedRes
Queued request times.
Gateway side of RC-MAC.
Definition: uan-mac-rc-gw.h:57
uint32_t m_numRates
Number of rates per Phy layer.
std::map< Mac8Address, Time > m_propDelay
Propagation delay to each node.
Forward calls to a chain of Callback.
Time m_sifs
Spacing between frames to account for timing error and processing delay.
uint16_t m_currentRetryRate
Retry rate number for current cycle.
double m_minRetryRate
Smallest allowed RTS retry rate.
virtual void Clear(void)
Clears all pointer references.
State m_state
Gateway processing state.
virtual ~UanMacRcGw()
Dummy destructor, see DoDispose.
a polymophic address class
Definition: address.h:90
uint8_t numFrames
Number of frames.
Definition: third.py:93
Gateway state.
Definition: uan-mac-rc-gw.h:95
std::vector< double > GetExpPdk(void)
Get the expected propagation delay to each node.
void ReceiveError(Ptr< Packet > pkt, double sinr)
PHY receive error callback.
Time m_maxDelta
Maximum propagation delay between gateway and non-gateway nodes .
double ComputeExpS(uint32_t a, uint32_t ld, std::vector< double > exppdk)
Throughput for a reservations with framesize ld, given expected delays exppdk.
std::map< Mac8Address, AckData > m_ackData
AckData for each node.
void SendPacket(Ptr< Packet > pkt, uint32_t rate)
Send packet on PHY.
Virtual base class for all UAN MAC protocols.
Definition: uan-mac.h:49
uint64_t NchooseK(uint32_t n, uint32_t k)
Binomial coefficient.
virtual bool Enqueue(Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest)
Enqueue packet to be transmitted.
uint32_t m_numNodes
Number of non-gateway nodes in this gateway&#39;s neighborhood.
Abstraction of packet modulation information.
Definition: uan-tx-mode.h:41
void ReceivePacket(Ptr< Packet > pkt, double sinr, UanTxMode mode)
PHY receive ok callback.
A class used for addressing MAC8 MAC&#39;s.
Definition: mac8-address.h:42
uint8_t frameNo
Current frame number.
virtual void DoDispose()
Destructor implementation.
uint32_t m_rateStep
Increments available for rate assignment in bps.
uint16_t length
Request header length.
TracedCallback< Ptr< const Packet >, UanTxMode > m_rxLogger
A packet was destined for and received at this MAC layer.
uint32_t m_currentRateNum
Rate number corresponding to data rate of current cycle.
uint32_t FindOptA(void)
Compute the optimum maximum number of reservations to accept per cycle.
uint8_t expFrames
Expected number of frames.
uint32_t m_ctsSizeN
Size of UanHeaderRcCts.
static TypeId GetTypeId(void)
Register this type.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Reservation request.
Cycling through nodes.
Definition: uan-mac-rc-gw.h:97
void(* CycleCallback)(Time now, Time delay, uint32_t numRts, uint32_t totalBytes, double secs, uint32_t ctlRate, double actualX)
TracedCallback signature for.
Definition: uan-mac-rc-gw.h:89
uint8_t frameNo
Frame number being ACK&#39;ed.
Ptr< UanPhy > m_phy
PHY layer attached to this MAC.
uint32_t m_frameSize
Size of data frames in bytes.
uint32_t m_totalRate
Total available channel rate in bps (for a single channel, without splitting reservation channel)...
Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > m_forwardUpCb
Forwarding up callback.
void StartCycle(void)
Cycle through pending requests.
uint32_t m_maxRes
Maximum number of reservations to accept per cycle.
void CycleStarted(void)
Set state to INCYCLE.
double ComputePiK(uint32_t a, uint32_t n, uint32_t k)
Numeric function.
uint32_t m_rtsSize
Size of UanHeaderCommon and UanHeaderRcRts.
void EndCycle(void)
End cycle by scheduling pending ACKs.
uint8_t retryNo
Retry number.
Initial idle state.
Definition: uan-mac-rc-gw.h:96
double ComputeAlpha(uint32_t totalFrames, uint32_t totalBytes, uint32_t n, uint32_t a, double deltaK)
Compute alpha parameter.
std::set< uint8_t > rxFrames
Received frames.
Packet ACK data.
a unique identifier for an interface.
Definition: type-id.h:58
uint32_t m_ackSize
Size of UanHeaderCommon and UanHeaderRcAck.
double ComputeExpBOverA(uint32_t n, uint32_t a, uint32_t ldlh, std::vector< double > deltaK)
Numeric function.
virtual void SetForwardUpCb(Callback< void, Ptr< Packet >, uint16_t, const Mac8Address &> cb)
Set the callback to forward packets up to higher layers.