A Discrete-Event Network Simulator
API
fdtbfq-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 FDTBFQ_FF_MAC_SCHEDULER_H
23 #define FDTBFQ_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 
39 #define NO_SINR -5000
40 
41 
43 #define HARQ_PROC_NUM 8
44 #define HARQ_DL_TIMEOUT 11
46 
47 namespace ns3 {
48 
49 
50 typedef std::vector < uint8_t > DlHarqProcessesStatus_t;
51 typedef std::vector < uint8_t > DlHarqProcessesTimer_t;
52 typedef std::vector < DlDciListElement_s > DlHarqProcessesDciBuffer_t;
53 typedef std::vector < std::vector <struct RlcPduListElement_s> > RlcPduList_t;
54 typedef std::vector < RlcPduList_t > DlHarqRlcPduListBuffer_t;
55 
56 typedef std::vector < UlDciListElement_s > UlHarqProcessesDciBuffer_t;
57 typedef std::vector < uint8_t > UlHarqProcessesStatus_t;
58 
59 
64 {
66  uint64_t packetArrivalRate;
68  uint32_t tokenPoolSize;
69  uint32_t maxTokenPoolSize;
70  int counter;
71  uint32_t burstCredit;
72  int debtLimit;
74 };
75 
84 {
85 public:
92 
96  virtual ~FdTbfqFfMacScheduler ();
97 
98  // inherited from Object
99  virtual void DoDispose (void);
104  static TypeId GetTypeId (void);
105 
106  // inherited from FfMacScheduler
111  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
116  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
127 
128  // FFR SAPs
133  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
138  virtual LteFfrSapUser* GetLteFfrSapUser ();
139 
144 
150  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
151 
152 private:
153  //
154  // Implementation of the CSCHED API primitives
155  // (See 4.1 for description of the primitives)
156  //
157 
163 
169 
175 
181 
187 
188  //
189  // Implementation of the SCHED API primitives
190  // (See 4.2 for description of the primitives)
191  //
192 
198 
204 
210 
217 
223 
229 
235 
241 
247 
253 
259 
260 
266  int GetRbgSize (int dlbandwidth);
267 
273  unsigned int LcActivePerFlow (uint16_t rnti);
274 
281  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
282 
284  void RefreshDlCqiMaps (void);
286  void RefreshUlCqiMaps (void);
287 
294  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
300  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
301 
308  uint8_t UpdateHarqProcessId (uint16_t rnti);
309 
316  uint8_t HarqProcessAvailability (uint16_t rnti);
317 
322  void RefreshHarqProcesses ();
323 
325 
329  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
330 
331 
335  std::map <uint16_t, fdtbfqsFlowPerf_t> m_flowStatsDl;
336 
340  std::map <uint16_t, fdtbfqsFlowPerf_t> m_flowStatsUl;
341 
345  std::map <uint16_t,uint8_t> m_p10CqiRxed;
346 
350  std::map <uint16_t,uint32_t> m_p10CqiTimers;
351 
355  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
356 
360  std::map <uint16_t,uint32_t> m_a30CqiTimers;
361 
366  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
367 
371  std::map <uint16_t, std::vector <double> > m_ueCqi;
372 
376  std::map <uint16_t, uint32_t> m_ueCqiTimers;
377 
381  std::map <uint16_t,uint32_t> m_ceBsrRxed;
382 
383  // MAC SAPs
388 
389  // FFR SAPs
392 
393  // Internal parameters
395 
396 
397  uint16_t m_nextRntiUl;
398 
400 
401  std::map <uint16_t,uint8_t> m_uesTxMode;
402 
403  uint64_t bankSize;
404 
406 
407  uint32_t m_creditLimit;
408 
409  uint32_t m_tokenPoolSize;
410 
412 
413  // HARQ attributes
414  bool m_harqOn;
415  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
416  //HARQ status
417  // 0: process Id available
418  // x>0: process Id equal to `x` transmission count
419  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
420  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
421  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
422  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
423  std::vector <DlInfoListElement_s> m_dlInfoListBuffered;
424 
425  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
426  //HARQ status
427  // 0: process Id available
428  // x>0: process Id equal to `x` transmission count
429  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
430  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
431 
432 
433  // RACH attributes
434  std::vector <struct RachListElement_s> m_rachList;
435  std::vector <uint16_t> m_rachAllocationMap;
436  uint8_t m_ulGrantMcs;
437 };
438 
439 } // namespace ns3
440 
441 #endif /* FDTBFQ_FF_MAC_SCHEDULER_H */
std::map< uint16_t, uint32_t > m_a30CqiTimers
Map of UE&#39;s timers on DL CQI A30 received.
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
Set FF MAC Csched SAP user function.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
Csched cell config request function.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
uint32_t creditableThreshold
the flow cannot borrow token from bank until the number of token it has deposited to bank reaches thi...
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
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs&#39; UL-CQI per RBG.
Time flowStart
flow start time
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE&#39;s LC info.
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Map of UE&#39;s DL CQI A30 received.
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request function.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request function.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request function.
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
UL HARQ process DCI buffer vector.
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request function.
std::vector< uint8_t > DlHarqProcessesTimer_t
DL HARQ process timer vector typedef.
int debtLimit
counter threshold that the flow cannot further borrow tokens from bank
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request function.
Provides the CSCHED SAP.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
uint32_t tokenPoolSize
current size of token pool (byte)
std::map< uint16_t, fdtbfqsFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request function.
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
virtual void SetLteFfrSapProvider(LteFfrSapProvider *s)
Set FFR SAP provider function.
uint32_t m_cqiTimersThreshold
of TTIs for which a CQI can be considered valid
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
virtual ~FdTbfqFfMacScheduler()
Destructor.
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
vector of the 8 HARQ processes per UE
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
Set FF MAC sched SAP user function.
std::vector< struct RachListElement_s > m_rachList
RACH list.
FfMacSchedSapUser * m_schedSapUser
sched SAP user
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
static TypeId GetTypeId(void)
Get the type ID.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
uint64_t packetArrivalRate
packet arrival rate( byte/s)
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request function.
std::map< uint16_t, fdtbfqsFlowPerf_t > m_flowStatsDl
Map of UE statistics (per RNTI basis) in downlink.
Service Access Point (SAP) offered by the Frequency Reuse algorithm instance to the MAC Scheduler ins...
Definition: lte-ffr-sap.h:39
Parameters of the SCHED_UL_TRIGGER_REQ primitive.
uint64_t bankSize
the number of bytes in token bank
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
Csched cell config.
Provides the SCHED SAP.
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
Get FF MAC CSched SAP provider function.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
uint32_t m_tokenPoolSize
maximum size of token pool (byte)
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE&#39;s timers on DL CQI P01 received.
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request function.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs&#39; timers on UL-CQI per RBG.
Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Token Bank Fair Queue scheduler...
uint32_t m_creditableThreshold
threshold of flow credit
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request function.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
DL HARQ process DCI buffer vector typedef.
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
unsigned int LcActivePerFlow(uint16_t rnti)
LC Active per flow function.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
MemberCschedSapProvider class.
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
uint64_t tokenGenerationRate
token generation rate ( byte/s )
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SNR function.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
int GetRbgSize(int dlbandwidth)
Get RBG size function.
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.
uint32_t burstCredit
the maximum number of tokens connection i can borrow from the bank each time
virtual LteFfrSapUser * GetLteFfrSapUser()
Get FFR SAP user function.
int counter
the number of token borrow or given to token bank
std::vector< uint8_t > UlHarqProcessesStatus_t
UL HARQ process status vector.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request function.
std::vector< uint8_t > DlHarqProcessesStatus_t
DL HARQ process status vector typedef.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
virtual void DoDispose(void)
Destructor implementation.
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request function.
FfMacSchedSapProvider * m_schedSapProvider
sched SAP provider
void RefreshDlCqiMaps(void)
Refresh DL CQI maps function.
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request function.
FfMacCschedSapUser * m_cschedSapUser
Csched SAP user.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request function.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
uint32_t m_creditLimit
flow credit limit (byte)
MemberSchedSapProvider class.
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
Get FF MAC sched SAP provider function.
uint32_t maxTokenPoolSize
maximum size of token pool (byte)
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE&#39;s DL CQI P01 received.
void RefreshUlCqiMaps(void)
Refresh UL CQI maps function.
a unique identifier for an interface.
Definition: type-id.h:58
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request function.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RLC buffer info function.
FfMacSchedSapUser class.
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request function.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
int m_debtLimit
flow debt limit (byte)
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE&#39;s buffer status reports received.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info function.
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmisson mode config update function.