A Discrete-Event Network Simulator
API
fdbet-ff-mac-scheduler.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
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: Marco Miozzo <marco.miozzo@cttc.es>
19  * Modification: Dizhi Zhou <dizhi.zhou@gmail.com> // modify codes related to downlink scheduler
20  */
21 
22 #ifndef FDBET_FF_MAC_SCHEDULER_H
23 #define FDBET_FF_MAC_SCHEDULER_H
24 
25 #include <ns3/lte-common.h>
26 #include <ns3/ff-mac-csched-sap.h>
27 #include <ns3/ff-mac-sched-sap.h>
28 #include <ns3/ff-mac-scheduler.h>
29 #include <vector>
30 #include <map>
31 #include <ns3/nstime.h>
32 #include <ns3/lte-amc.h>
33 #include <ns3/lte-ffr-sap.h>
34 
35 // value for SINR outside the range defined by FF-API, used to indicate that there
36 // is no CQI for this element
37 #define NO_SINR -5000
38 
39 
40 #define HARQ_PROC_NUM 8
41 #define HARQ_DL_TIMEOUT 11
42 
43 namespace ns3 {
44 
45 
46 typedef std::vector < uint8_t > DlHarqProcessesStatus_t;
47 typedef std::vector < uint8_t > DlHarqProcessesTimer_t;
48 typedef std::vector < DlDciListElement_s > DlHarqProcessesDciBuffer_t;
49 typedef std::vector < std::vector <struct RlcPduListElement_s> > RlcPduList_t; // vector of the LCs and layers per UE
50 typedef std::vector < RlcPduList_t > DlHarqRlcPduListBuffer_t; // vector of the 8 HARQ processes per UE
51 
52 typedef std::vector < UlDciListElement_s > UlHarqProcessesDciBuffer_t;
53 typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
54 
55 
58 {
60  unsigned long totalBytesTransmitted;
61  unsigned int lastTtiBytesTrasmitted;
63 };
64 
65 
74 {
75 public:
82 
86  virtual ~FdBetFfMacScheduler ();
87 
88  // inherited from Object
89  virtual void DoDispose (void);
94  static TypeId GetTypeId (void);
95 
96  // inherited from FfMacScheduler
97  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
98  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
101 
102  // FFR SAPs
103  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
104  virtual LteFfrSapUser* GetLteFfrSapUser ();
105 
110 
116  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
117 
118 private:
119  //
120  // Implementation of the CSCHED API primitives
121  // (See 4.1 for description of the primitives)
122  //
123 
129 
135 
141 
147 
153 
154  //
155  // Implementation of the SCHED API primitives
156  // (See 4.2 for description of the primitives)
157  //
158 
164 
170 
176 
183 
189 
195 
201 
207 
213 
219 
225 
226 
232  int GetRbgSize (int dlbandwidth);
233 
239  unsigned int LcActivePerFlow (uint16_t rnti);
240 
247  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
248 
250  void RefreshDlCqiMaps (void);
252  void RefreshUlCqiMaps (void);
253 
260  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
266  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
267 
274  uint8_t UpdateHarqProcessId (uint16_t rnti);
275 
282  uint8_t HarqProcessAvailability (uint16_t rnti);
283 
288  void RefreshHarqProcesses ();
289 
291 
295  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
296 
297 
301  std::map <uint16_t, fdbetsFlowPerf_t> m_flowStatsDl;
302 
306  std::map <uint16_t, fdbetsFlowPerf_t> m_flowStatsUl;
307 
311  std::map <uint16_t,uint8_t> m_p10CqiRxed;
312 
316  std::map <uint16_t,uint32_t> m_p10CqiTimers;
317 
321  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
322 
326  std::map <uint16_t,uint32_t> m_a30CqiTimers;
327 
332  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
333 
337  std::map <uint16_t, std::vector <double> > m_ueCqi;
338 
342  std::map <uint16_t, uint32_t> m_ueCqiTimers;
343 
347  std::map <uint16_t,uint32_t> m_ceBsrRxed;
348 
349  // MAC SAPs
354 
355  // FFR SAPs
358 
359  // Internal parameters
361 
362 
363  double m_timeWindow;
364 
365  uint16_t m_nextRntiUl;
366 
368 
369  std::map <uint16_t,uint8_t> m_uesTxMode;
370 
371  // HARQ attributes
372  bool m_harqOn;
373  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
374  //HARQ status
375  // 0: process Id available
376  // x>0: process Id equal to `x` transmission count
377  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
378  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
379  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
380  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
381  std::vector <DlInfoListElement_s> m_dlInfoListBuffered;
382 
383  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
384  //HARQ status
385  // 0: process Id available
386  // x>0: process Id equal to `x` transmission count
387  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
388  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
389 
390 
391  // RACH attributes
392  std::vector <struct RachListElement_s> m_rachList;
393  std::vector <uint16_t> m_rachAllocationMap;
394  uint8_t m_ulGrantMcs;
395 
396 };
397 
398 } // namespace ns3
399 
400 #endif /* FDBET_FF_MAC_SCHEDULER_H */
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
Time flowStart
flow start time
uint32_t m_cqiTimersThreshold
of TTIs for which a CQI can be considered valid
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
std::vector< std::vector< struct RlcPduListElement_s > > RlcPduList_t
vector of the LCs and layers per UE
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
Service Access Point (SAP) offered by the eNodeB RRC instance to the Frequency Reuse algorithm instan...
Definition: lte-ffr-sap.h:138
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info.
virtual ~FdBetFfMacScheduler()
Destructor.
static TypeId GetTypeId(void)
Get the type ID.
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request function.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request function.
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
UL HARQ process DCI buffer vector.
LteFfrSapUser * m_ffrSapUser
ffr sap user
void RefreshDlCqiMaps(void)
Refresh DL CQI maps.
virtual void DoDispose(void)
Destructor implementation.
std::vector< uint8_t > DlHarqProcessesTimer_t
DL HARQ process timer vector typedef.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
Provides the CSCHED SAP.
std::map< uint16_t, fdbetsFlowPerf_t > m_flowStatsDl
Map of UE statistics (per RNTI basis) in downlink.
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE&#39;s DL CQI P01 received.
std::vector< uint16_t > m_rachAllocationMap
rach allocation map
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request function.
FfMacSchedSapUser * m_schedSapUser
sched sap user
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request function.
Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Blind Equal Throughput scheduler...
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
vector of the 8 HARQ processes per UE
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs&#39; timers on UL-CQI per RBG.
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CGI info request function.
void RefreshUlCqiMaps(void)
Refresh UL CQI maps.
unsigned int LcActivePerFlow(uint16_t rnti)
LC active per flow function.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI Buffer.
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition: lte-ffr-sap.h:39
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request function.
Parameters of the SCHED_UL_TRIGGER_REQ primitive.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
CSched cell config request function.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
FfMacCschedSapProvider * m_cschedSapProvider
csched sap provider
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
LteFfrSapProvider * m_ffrSapProvider
ffr sap provider
double lastAveragedThroughput
last averaged throughput
unsigned long totalBytesTransmitted
total bytes transmitted
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
Provides the SCHED SAP.
virtual void SetLteFfrSapProvider(LteFfrSapProvider *s)
Set the Provider part of the LteFfrSap that this Scheduler will interact with.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE&#39;s timers on DL CQI P01 received.
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SNR.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RLC buffer info.
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU List.
FfMacSchedSapProvider * m_schedSapProvider
sched sap provider
int GetRbgSize(int dlbandwidth)
Get RBG size function.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CGI info request function.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
FfMacCschedSapUser * m_cschedSapUser
csched sap user
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
DL HARQ process DCI buffer vector typedef.
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs&#39; UL-CQI per RBG.
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
virtual LteFfrSapUser * GetLteFfrSapUser()
MemberCschedSapProvider class.
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE&#39;s timers on DL CQI A30 received.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
std::vector< struct RachListElement_s > m_rachList
rach list
This abstract base class identifies the interface by means of which the helper object can plug on the...
FfMacCschedSapUser class.
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
DL HARQ retx buffered.
std::vector< uint8_t > UlHarqProcessesStatus_t
UL HARQ process status vector.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request function.
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request function.
std::vector< uint8_t > DlHarqProcessesStatus_t
DL HARQ process status vector typedef.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmission mode configuration update function.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
Csched LC config request function.
unsigned int lastTtiBytesTrasmitted
last total bytes transmitted
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
std::map< uint16_t, fdbetsFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request function.
MemberSchedSapProvider class.
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request function.
a unique identifier for an interface.
Definition: type-id.h:58
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE&#39;s LC info.
FfMacSchedSapUser class.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
Csched UE config request function.
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
csched cell config
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE&#39;s DL CQI A30 received.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request function.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE&#39;s buffer status reports received.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request function.
fdbetsFlowPerf_t structure