A Discrete-Event Network Simulator
API
tdtbfq-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 TDTBFQ_FF_MAC_SCHEDULER_H
23 #define TDTBFQ_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 
60 {
62  uint64_t packetArrivalRate;
64  uint32_t tokenPoolSize;
65  uint32_t maxTokenPoolSize;
66  int counter;
67  uint32_t burstCredit;
68  int debtLimit;
70 };
71 
80 {
81 public:
88 
92  virtual ~TdTbfqFfMacScheduler ();
93 
94  // inherited from Object
95  virtual void DoDispose (void);
100  static TypeId GetTypeId (void);
101 
102  // inherited from FfMacScheduler
103  virtual void SetFfMacCschedSapUser (FfMacCschedSapUser* s);
104  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
107 
108  // FFR SAPs
109  virtual void SetLteFfrSapProvider (LteFfrSapProvider* s);
110  virtual LteFfrSapUser* GetLteFfrSapUser ();
111 
116 
122  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
123 
124 private:
125  //
126  // Implementation of the CSCHED API primitives
127  // (See 4.1 for description of the primitives)
128  //
129 
135 
141 
147 
153 
159 
160  //
161  // Implementation of the SCHED API primitives
162  // (See 4.2 for description of the primitives)
163  //
164 
170 
176 
182 
188 
194 
200 
206 
212 
218 
224 
230 
236  int GetRbgSize (int dlbandwidth);
237 
243  unsigned int LcActivePerFlow (uint16_t rnti);
244 
251  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
252 
254  void RefreshDlCqiMaps (void);
256  void RefreshUlCqiMaps (void);
257 
264  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
270  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
271 
278  uint8_t UpdateHarqProcessId (uint16_t rnti);
279 
286  uint8_t HarqProcessAvailability (uint16_t rnti);
287 
292  void RefreshHarqProcesses ();
293 
295 
299  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
300 
301 
305  std::map <uint16_t, tdtbfqsFlowPerf_t> m_flowStatsDl;
306 
310  std::map <uint16_t, tdtbfqsFlowPerf_t> m_flowStatsUl;
311 
312 
316  std::map <uint16_t,uint8_t> m_p10CqiRxed;
320  std::map <uint16_t,uint32_t> m_p10CqiTimers;
321 
325  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
329  std::map <uint16_t,uint32_t> m_a30CqiTimers;
330 
335  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
336 
340  std::map <uint16_t, std::vector <double> > m_ueCqi;
344  std::map <uint16_t, uint32_t> m_ueCqiTimers;
345 
349  std::map <uint16_t,uint32_t> m_ceBsrRxed;
350 
351  // MAC SAPs
356 
357  // FFR SAPs
360 
361  // Internal parameters
363 
364 
365  uint16_t m_nextRntiUl;
366 
368 
369  std::map <uint16_t,uint8_t> m_uesTxMode;
370 
371  uint64_t bankSize;
372 
374 
375  uint32_t m_creditLimit;
376 
377  uint32_t m_tokenPoolSize;
378 
380 
381  // HARQ attributes
385  bool m_harqOn;
386  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
387  //HARQ status
388  // 0: process Id available
389  // x>0: process Id equal to `x` transmission count
390  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
391  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
392  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
393  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
394  std::vector <DlInfoListElement_s> m_dlInfoListBuffered;
395 
396  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
397  //HARQ status
398  // 0: process Id available
399  // x>0: process Id equal to `x` transmission count
400  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
401  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
402 
403 
404  // RACH attributes
405  std::vector <struct RachListElement_s> m_rachList;
406  std::vector <uint16_t> m_rachAllocationMap;
407  uint8_t m_ulGrantMcs;
408 };
409 
410 } // namespace ns3
411 
412 #endif /* TDTBFQ_FF_MAC_SCHEDULER_H */
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
Sched UL noise interference request.
void RefreshUlCqiMaps(void)
Refresh UL CQI maps function.
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
CSched LC release request.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
DL HARQ current process ID.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
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
virtual void DoDispose(void)
Destructor implementation.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
Sched DL RLC buffer request.
Time flowStart
flow start time
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
CSched UE config request.
uint32_t m_creditLimit
flow credit limit (byte)
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Sched DL RACH info request.
uint32_t burstCredit
the maximum number of tokens connection i can borrow from the bank each time
FfMacSchedSapProvider * m_schedSapProvider
Sched SAP provider.
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
UL HARQ process DCI buffer vector.
uint32_t maxTokenPoolSize
maximum size of token pool (byte)
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
Estimate UL SINR function.
std::vector< uint8_t > DlHarqProcessesTimer_t
DL HARQ process timer vector typedef.
virtual ~TdTbfqFfMacScheduler()
Destructor.
unsigned int LcActivePerFlow(uint16_t rnti)
LC active flow size.
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
Provides the CSCHED SAP.
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
CSched LC config request.
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
int counter
the number of token borrow or given to token bank
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)
Transmission mde configuration update function.
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
Vectors of UE&#39;s LC info.
Implements the SCHED SAP and CSCHED SAP for a Time Domain Token Bank Fair Queue scheduler.
std::vector< struct RachListElement_s > m_rachList
RACH list.
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
FfMacCschedSapUser * m_cschedSapUser
CSched SAP user.
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
Sched UL trigger request.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
DL HARQ process timer.
void RefreshDlCqiMaps(void)
Refresh DL CQI maps function.
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.
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
Sched UL SR info request.
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
Map of previous allocated UE per RBG (used to retrieve info from UL-CQI)
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.
int debtLimit
counter threshold that the flow cannot further borrow tokens from bank
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_a30CqiTimers
Map of UE&#39;s timers on DL CQI A30 received.
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
Update DL RLC buffer info function.
Provides the SCHED SAP.
uint16_t m_nextRntiUl
RNTI of the next user to be served next scheduling in UL.
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Sched DL CQI info request.
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
Sched DL MAC buffer request.
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
UL HARQ process DCI buffer.
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
DL HARQ process RLC PDU list buffer.
FfMacSchedSapUser * m_schedSapUser
A=Sched SAP user.
virtual LteFfrSapUser * GetLteFfrSapUser()
std::map< uint16_t, DlHarqProcessesStatus_t > m_dlHarqProcessesStatus
DL HARQ process status.
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
uint64_t tokenGenerationRate
token generation rate ( byte/s )
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::map< uint16_t, std::vector< double > > m_ueCqi
Map of UEs&#39; UL-CQI per RBG.
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, SbMeasResult_s > m_a30CqiRxed
Map of UE&#39;s DL CQI A30 received.
std::map< uint16_t, uint8_t > m_p10CqiRxed
Map of UE&#39;s DL CQI P01 received.
MemberCschedSapProvider class.
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
HARQ retx buffered.
uint32_t creditableThreshold
the flow cannot borrow token from bank until the number of token it has deposited to bank reaches thi...
uint32_t tokenPoolSize
current size of token pool (byte)
This abstract base class identifies the interface by means of which the helper object can plug on the...
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
FfMacCschedSapUser class.
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
CSched UE release request.
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
std::map< uint16_t, tdtbfqsFlowPerf_t > m_flowStatsDl
Map of UE statistics (per RNTI basis) in downlink.
bool m_harqOn
m_harqOn when false inhibit the HARQ mechanisms (by default active)
std::map< uint16_t, uint8_t > m_uesTxMode
txMode of the UEs
std::vector< uint8_t > UlHarqProcessesStatus_t
UL HARQ process status vector.
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
Update UL RLC buffer info function.
std::map< uint16_t, uint32_t > m_ueCqiTimers
Map of UEs&#39; timers on UL-CQI per RBG.
std::vector< uint8_t > DlHarqProcessesStatus_t
DL HARQ process status vector typedef.
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
uint64_t bankSize
the number of bytes in token bank
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
uint32_t m_cqiTimersThreshold
of TTIs for which a CQI can be considered valid
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
CSched cell config.
Parameters of the SCHED_UL_SR_INFO_REQ primitive.
LteFfrSapUser * m_ffrSapUser
FFR SAP user.
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
Sched UL CQI info request.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
CSched cell config request.
FfMacCschedSapProvider * m_cschedSapProvider
CSched SAP provider.
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
DL HARQ process DCI buffer.
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
Parameters of the SCHED_DL_RACH_INFO_REQ primitive.
uint32_t m_creditableThreshold
threshold of flow credit
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
Sched DL paging buffer request.
MemberSchedSapProvider class.
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
uint64_t packetArrivalRate
packet arrival rate( byte/s)
LteFfrSapProvider * m_ffrSapProvider
FFR SAP provider.
int m_debtLimit
flow debt limit (byte)
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
Sched UL MAC control info request.
std::vector< uint16_t > m_rachAllocationMap
RACH allocation map.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
UL HARQ process status.
std::map< uint16_t, uint32_t > m_ceBsrRxed
Map of UE&#39;s buffer status reports received.
a unique identifier for an interface.
Definition: type-id.h:58
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
Sched DL trigger request.
std::map< uint16_t, uint32_t > m_p10CqiTimers
Map of UE&#39;s timers on DL CQI P01 received.
uint32_t m_tokenPoolSize
maximum size of token pool (byte)
int GetRbgSize(int dlbandwidth)
Get RBG size.
FfMacSchedSapUser class.
uint8_t m_ulGrantMcs
MCS for UL grant (default 0)
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
UL HARQ current process ID.
std::map< uint16_t, tdtbfqsFlowPerf_t > m_flowStatsUl
Map of UE statistics (per RNTI basis)
static TypeId GetTypeId(void)
Get the type ID.