A Discrete-Event Network Simulator
API
uan-mac-rc-gw.h
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
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
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 */
20
21#ifndef UAN_MAC_RC_GW_H
22#define UAN_MAC_RC_GW_H
23
24#include "uan-mac.h"
25#include "ns3/mac8-address.h"
26
27#include "ns3/nstime.h"
28#include "ns3/traced-callback.h"
29
30
31
32
33#include <set>
34#include <map>
35
36namespace ns3 {
37
38class UanTxMode;
39
57class UanMacRcGw : public UanMac
58{
59public:
60 UanMacRcGw ();
61 virtual ~UanMacRcGw ();
62
67 static TypeId GetTypeId (void);
68
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);
75
88 typedef void (* CycleCallback)
89 (Time now, Time delay, uint32_t numRts, uint32_t totalBytes,
90 double secs, uint32_t ctlRate, double actualX);
91
92
93private:
95 enum State {
98 CTSING
99 };
101
106 struct Request
107 {
108 uint8_t numFrames;
109 uint8_t frameNo;
110 uint8_t retryNo;
111 uint16_t length;
113 };
114
119 struct AckData
120 {
121 uint8_t frameNo;
122 std::set<uint8_t> rxFrames;
123 uint8_t expFrames;
124 };
127
143
145 double m_retryStep;
146
148 std::map<Mac8Address, Time> m_propDelay;
149
151 std::map<Mac8Address, AckData> m_ackData;
152
154 std::map<Mac8Address, Request> m_requests;
156 std::set<std::pair<Time, Mac8Address> > m_sortedRes;
157
160
163
177
185 void ReceivePacket (Ptr<Packet> pkt, double sinr, UanTxMode mode);
186
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);
207
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);
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);
285protected:
286 virtual void DoDispose ();
287
288}; // class UanMacRcGw
289
290} // namespace ns3
291
292#endif /* UAN_MAC_RC_GW_H */
a polymophic address class
Definition: address.h:91
Callback template class.
Definition: callback.h:1279
A class used for addressing MAC8 MAC's.
Definition: mac8-address.h:43
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
Virtual base class for all UAN MAC protocols.
Definition: uan-mac.h:50
Gateway side of RC-MAC.
Definition: uan-mac-rc-gw.h:58
uint32_t m_numNodes
Number of non-gateway nodes in this gateway's neighborhood.
void ReceiveError(Ptr< Packet > pkt, double sinr)
PHY receive error callback.
virtual bool Enqueue(Ptr< Packet > pkt, uint16_t protocolNumber, const Address &dest)
Enqueue packet to be transmitted.
void SendPacket(Ptr< Packet > pkt, uint32_t rate)
Send packet on PHY.
virtual void DoDispose()
Destructor implementation.
uint32_t m_maxRes
Maximum number of reservations to accept per cycle.
double ComputeAlpha(uint32_t totalFrames, uint32_t totalBytes, uint32_t n, uint32_t a, double deltaK)
Compute alpha parameter.
virtual void Clear(void)
Clears all pointer references.
double m_minRetryRate
Smallest allowed RTS retry rate.
uint16_t m_currentRetryRate
Retry rate number for current cycle.
virtual void SetForwardUpCb(Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > cb)
Set the callback to forward packets up to higher layers.
uint32_t m_ctsSizeN
Size of UanHeaderRcCts.
UanMacRcGw()
Constructor.
static TypeId GetTypeId(void)
Register this type.
uint32_t m_rateStep
Increments available for rate assignment in bps.
std::map< Mac8Address, AckData > m_ackData
AckData for each node.
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
int64_t AssignStreams(int64_t stream)
Assign a fixed random variable stream number to the random variables used by this model.
TracedCallback< Time, Time, uint32_t, uint32_t, double, uint32_t, double > m_cycleLogger
A packet was destined for and received at this MAC layer.
std::set< std::pair< Time, Mac8Address > > m_sortedRes
Queued request times.
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.
Time m_sifs
Spacing between frames to account for timing error and processing delay.
bool m_cleared
Flag when we've been cleared.
uint32_t m_ctsSizeG
Size of UanHeaderCommon and UanHeaderRcCtsGlobal.
Ptr< UanPhy > m_phy
PHY layer attached to this MAC.
State
Gateway state.
Definition: uan-mac-rc-gw.h:95
@ CTSING
Sending CTS.
Definition: uan-mac-rc-gw.h:98
@ INCYCLE
Cycling through nodes.
Definition: uan-mac-rc-gw.h:97
@ IDLE
Initial idle state.
Definition: uan-mac-rc-gw.h:96
uint32_t m_frameSize
Size of data frames in bytes.
uint64_t NchooseK(uint32_t n, uint32_t k)
Binomial coefficient.
uint32_t m_numRates
Number of rates per Phy layer.
void CycleStarted(void)
Set state to INCYCLE.
void ReceivePacket(Ptr< Packet > pkt, double sinr, UanTxMode mode)
PHY receive ok callback.
Callback< void, Ptr< Packet >, uint16_t, const Mac8Address & > m_forwardUpCb
Forwarding up callback.
uint32_t m_currentRateNum
Rate number corresponding to data rate of current cycle.
double ComputePiK(uint32_t a, uint32_t n, uint32_t k)
Numeric function.
uint32_t m_totalRate
Total available channel rate in bps (for a single channel, without splitting reservation channel).
uint32_t m_rtsSize
Size of UanHeaderCommon and UanHeaderRcRts.
State m_state
Gateway processing state.
void StartCycle(void)
Cycle through pending requests.
uint32_t FindOptA(void)
Compute the optimum maximum number of reservations to accept per cycle.
std::map< Mac8Address, Request > m_requests
Request for each node.
double m_retryStep
Retry rate increment.
virtual void AttachPhy(Ptr< UanPhy > phy)
Attach PHY layer to this MAC.
double ComputeExpBOverA(uint32_t n, uint32_t a, uint32_t ldlh, std::vector< double > deltaK)
Numeric function.
std::map< Mac8Address, Time > m_propDelay
Propagation delay to each node.
std::vector< double > GetExpPdk(void)
Get the expected propagation delay to each node.
uint32_t m_ackSize
Size of UanHeaderCommon and UanHeaderRcAck.
uint32_t CompExpMinIndex(uint32_t n, uint32_t k)
Index to the k'th expected delay among n nodes.
TracedCallback< Ptr< const Packet >, UanTxMode > m_rxLogger
A packet was destined for and received at this MAC layer.
void EndCycle(void)
End cycle by scheduling pending ACKs.
virtual ~UanMacRcGw()
Dummy destructor, see DoDispose.
Abstraction of packet modulation information.
Definition: uan-tx-mode.h:42
Every class exported by the ns3 library is enclosed in the ns3 namespace.
phy
Definition: third.py:84
uint8_t expFrames
Expected number of frames.
uint8_t frameNo
Frame number being ACK'ed.
std::set< uint8_t > rxFrames
Received frames.
Reservation request.
uint8_t retryNo
Retry number.
uint16_t length
Request header length.
uint8_t frameNo
Current frame number.
uint8_t numFrames
Number of frames.
Time rxTime
Time request received.