A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 
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 ~FdTbfqFfMacScheduler ();
93 
94  // inherited from Object
95  virtual void DoDispose (void);
96  static TypeId GetTypeId (void);
97 
98  // inherited from FfMacScheduler
100  virtual void SetFfMacSchedSapUser (FfMacSchedSapUser* s);
103 
106 
107  void TransmissionModeConfigurationUpdate (uint16_t rnti, uint8_t txMode);
108 
109 private:
110  //
111  // Implementation of the CSCHED API primitives
112  // (See 4.1 for description of the primitives)
113  //
114 
116 
118 
120 
122 
124 
125  //
126  // Implementation of the SCHED API primitives
127  // (See 4.2 for description of the primitives)
128  //
129 
131 
133 
135 
137 
139 
141 
143 
145 
147 
149 
151 
152 
153  int GetRbgSize (int dlbandwidth);
154 
155  int LcActivePerFlow (uint16_t rnti);
156 
157  double EstimateUlSinr (uint16_t rnti, uint16_t rb);
158 
159  void RefreshDlCqiMaps (void);
160  void RefreshUlCqiMaps (void);
161 
162  void UpdateDlRlcBufferInfo (uint16_t rnti, uint8_t lcid, uint16_t size);
163  void UpdateUlRlcBufferInfo (uint16_t rnti, uint16_t size);
164 
171  uint8_t UpdateHarqProcessId (uint16_t rnti);
172 
179  uint8_t HarqProcessAvailability (uint16_t rnti);
180 
185  void RefreshHarqProcesses ();
186 
188 
189  /*
190  * Vectors of UE's LC info
191  */
192  std::map <LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters> m_rlcBufferReq;
193 
194 
195  /*
196  * Map of UE statistics (per RNTI basis) in downlink
197  */
198  std::map <uint16_t, fdtbfqsFlowPerf_t> m_flowStatsDl;
199 
200  /*
201  * Map of UE statistics (per RNTI basis)
202  */
203  std::map <uint16_t, fdtbfqsFlowPerf_t> m_flowStatsUl;
204 
205 
206  /*
207  * Map of UE's DL CQI P01 received
208  */
209  std::map <uint16_t,uint8_t> m_p10CqiRxed;
210  /*
211  * Map of UE's timers on DL CQI P01 received
212  */
213  std::map <uint16_t,uint32_t> m_p10CqiTimers;
214 
215  /*
216  * Map of UE's DL CQI A30 received
217  */
218  std::map <uint16_t,SbMeasResult_s> m_a30CqiRxed;
219  /*
220  * Map of UE's timers on DL CQI A30 received
221  */
222  std::map <uint16_t,uint32_t> m_a30CqiTimers;
223 
224  /*
225  * Map of previous allocated UE per RBG
226  * (used to retrieve info from UL-CQI)
227  */
228  std::map <uint16_t, std::vector <uint16_t> > m_allocationMaps;
229 
230  /*
231  * Map of UEs' UL-CQI per RBG
232  */
233  std::map <uint16_t, std::vector <double> > m_ueCqi;
234  /*
235  * Map of UEs' timers on UL-CQI per RBG
236  */
237  std::map <uint16_t, uint32_t> m_ueCqiTimers;
238 
239  /*
240  * Map of UE's buffer status reports received
241  */
242  std::map <uint16_t,uint32_t> m_ceBsrRxed;
243 
244  // MAC SAPs
249 
250 
251  // Internal parameters
253 
254 
255  uint16_t m_nextRntiUl; // RNTI of the next user to be served next scheduling in UL
256 
257  uint32_t m_cqiTimersThreshold; // # of TTIs for which a CQI canbe considered valid
258 
259  std::map <uint16_t,uint8_t> m_uesTxMode; // txMode of the UEs
260 
261  uint64_t bankSize; // the number of bytes in token bank
262 
263  int m_debtLimit; // flow debt limit (byte)
264 
265  uint32_t m_creditLimit; // flow credit limit (byte)
266 
267  uint32_t m_tokenPoolSize; // maximum size of token pool (byte)
268 
269  uint32_t m_creditableThreshold; // threshold of flow credit
270 
271  // HARQ attributes
275  bool m_harqOn;
276  std::map <uint16_t, uint8_t> m_dlHarqCurrentProcessId;
277  //HARQ status
278  // 0: process Id available
279  // x>0: process Id equal to `x` trasmission count
280  std::map <uint16_t, DlHarqProcessesStatus_t> m_dlHarqProcessesStatus;
281  std::map <uint16_t, DlHarqProcessesTimer_t> m_dlHarqProcessesTimer;
282  std::map <uint16_t, DlHarqProcessesDciBuffer_t> m_dlHarqProcessesDciBuffer;
283  std::map <uint16_t, DlHarqRlcPduListBuffer_t> m_dlHarqProcessesRlcPduListBuffer;
284  std::vector <DlInfoListElement_s> m_dlInfoListBuffered; // HARQ retx buffered
285 
286  std::map <uint16_t, uint8_t> m_ulHarqCurrentProcessId;
287  //HARQ status
288  // 0: process Id available
289  // x>0: process Id equal to `x` trasmission count
290  std::map <uint16_t, UlHarqProcessesStatus_t> m_ulHarqProcessesStatus;
291  std::map <uint16_t, UlHarqProcessesDciBuffer_t> m_ulHarqProcessesDciBuffer;
292 
293 
294  // RACH attributes
295  std::vector <struct RachListElement_s> m_rachList;
296  std::vector <uint16_t> m_rachAllocationMap;
297  uint8_t m_ulGrantMcs; // MCS for UL grant (default 0)
298 };
299 
300 } // namespace ns3
301 
302 #endif /* FDTBFQ_FF_MAC_SCHEDULER_H */
std::map< uint16_t, uint32_t > m_a30CqiTimers
virtual void SetFfMacCschedSapUser(FfMacCschedSapUser *s)
set the user part of the FfMacCschedSap that this Scheduler will interact with.
void DoCschedCellConfigReq(const struct FfMacCschedSapProvider::CschedCellConfigReqParameters &params)
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:79
uint32_t creditableThreshold
counter threshold that the flow cannot further borrow tokens from bank
std::vector< std::vector< struct RlcPduListElement_s > > RlcPduList_t
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:60
std::map< uint16_t, uint8_t > m_uesTxMode
std::map< uint16_t, std::vector< double > > m_ueCqi
std::map< LteFlowId_t, FfMacSchedSapProvider::SchedDlRlcBufferReqParameters > m_rlcBufferReq
std::map< uint16_t, SbMeasResult_s > m_a30CqiRxed
Parameters of the CSCHED_UE_RELEASE_REQ primitive.
void DoSchedUlNoiseInterferenceReq(const struct FfMacSchedSapProvider::SchedUlNoiseInterferenceReqParameters &params)
void DoCschedLcConfigReq(const struct FfMacCschedSapProvider::CschedLcConfigReqParameters &params)
std::map< uint16_t, UlHarqProcessesDciBuffer_t > m_ulHarqProcessesDciBuffer
void DoSchedUlSrInfoReq(const struct FfMacSchedSapProvider::SchedUlSrInfoReqParameters &params)
std::vector< UlDciListElement_s > UlHarqProcessesDciBuffer_t
void DoSchedDlPagingBufferReq(const struct FfMacSchedSapProvider::SchedDlPagingBufferReqParameters &params)
std::vector< uint8_t > DlHarqProcessesTimer_t
int debtLimit
the maximum number of tokens connection i can borrow from the bank each time
void DoSchedDlCqiInfoReq(const struct FfMacSchedSapProvider::SchedDlCqiInfoReqParameters &params)
Provides the CSCHED SAP.
bool m_harqOn
m_harqOn when false inhibit te HARQ mechanisms (by default active)
uint32_t tokenPoolSize
token generation rate ( byte/s )
std::map< uint16_t, fdtbfqsFlowPerf_t > m_flowStatsUl
void DoSchedDlRachInfoReq(const struct FfMacSchedSapProvider::SchedDlRachInfoReqParameters &params)
Parameters of the CSCHED_LC_RELEASE_REQ primitive.
Parameters of the SCHED_DL_TRIGGER_REQ primitive.
virtual ~FdTbfqFfMacScheduler()
Destructor.
std::vector< RlcPduList_t > DlHarqRlcPduListBuffer_t
Parameters of the SCHED_DL_MAC_BUFFER_REQ primitive.
Parameters of the SCHED_DL_PAGING_BUFFER_REQ primitive.
virtual void SetFfMacSchedSapUser(FfMacSchedSapUser *s)
set the user part of the FfMacSchedSap that this Scheduler will interact with.
std::vector< struct RachListElement_s > m_rachList
std::map< uint16_t, std::vector< uint16_t > > m_allocationMaps
std::map< uint16_t, DlHarqProcessesDciBuffer_t > m_dlHarqProcessesDciBuffer
uint8_t HarqProcessAvailability(uint16_t rnti)
Return the availability of free process for the RNTI specified.
std::map< uint16_t, DlHarqProcessesTimer_t > m_dlHarqProcessesTimer
void DoCschedLcReleaseReq(const struct FfMacCschedSapProvider::CschedLcReleaseReqParameters &params)
std::map< uint16_t, fdtbfqsFlowPerf_t > m_flowStatsDl
Parameters of the SCHED_UL_TRIGGER_REQ primitive.
Ptr< SampleEmitter > s
FfMacCschedSapProvider::CschedCellConfigReqParameters m_cschedCellConfig
Provides the SCHED SAP.
virtual FfMacCschedSapProvider * GetFfMacCschedSapProvider()
std::vector< uint16_t > m_rachAllocationMap
std::map< uint16_t, uint32_t > m_p10CqiTimers
Parameters of the SCHED_UL_NOISE_INTERFERENCE_REQ primitive.
void DoSchedDlRlcBufferReq(const struct FfMacSchedSapProvider::SchedDlRlcBufferReqParameters &params)
std::map< uint16_t, uint32_t > m_ueCqiTimers
Implements the SCHED SAP and CSCHED SAP for a Frequency Domain Token Bank Fair Queue scheduler...
void DoSchedUlMacCtrlInfoReq(const struct FfMacSchedSapProvider::SchedUlMacCtrlInfoReqParameters &params)
std::vector< DlDciListElement_s > DlHarqProcessesDciBuffer_t
Parameters of the CSCHED_LC_CONFIG_REQ primitive.
void RefreshHarqProcesses()
Refresh HARQ processes according to the timers.
std::map< uint16_t, uint8_t > m_dlHarqCurrentProcessId
FfMacCschedSapProvider * m_cschedSapProvider
uint64_t tokenGenerationRate
packet arrival rate( byte/s)
double EstimateUlSinr(uint16_t rnti, uint16_t rb)
std::map< uint16_t, DlHarqRlcPduListBuffer_t > m_dlHarqProcessesRlcPduListBuffer
This abstract base class identifies the interface by means of which the helper object can plug on the...
Parameters of the SCHED_DL_CQI_INFO_REQ primitive.
uint32_t burstCredit
the number of token borrow or given to token bank
int counter
maximum size of token pool (byte)
std::vector< uint8_t > UlHarqProcessesStatus_t
void DoSchedUlCqiInfoReq(const struct FfMacSchedSapProvider::SchedUlCqiInfoReqParameters &params)
std::vector< uint8_t > DlHarqProcessesStatus_t
Parameters of the SCHED_UL_CQI_INFO_REQ primitive.
virtual void DoDispose(void)
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
void DoSchedDlTriggerReq(const struct FfMacSchedSapProvider::SchedDlTriggerReqParameters &params)
FfMacSchedSapProvider * m_schedSapProvider
Parameters of the SCHED_UL_MAC_CTRL_INFO_REQ primitive.
std::map< uint16_t, UlHarqProcessesStatus_t > m_ulHarqProcessesStatus
void DoSchedDlMacBufferReq(const struct FfMacSchedSapProvider::SchedDlMacBufferReqParameters &params)
FfMacCschedSapUser * m_cschedSapUser
void DoSchedUlTriggerReq(const struct FfMacSchedSapProvider::SchedUlTriggerReqParameters &params)
std::vector< DlInfoListElement_s > m_dlInfoListBuffered
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
Parameters of the CSCHED_UE_CONFIG_REQ primitive.
std::map< uint16_t, uint8_t > m_ulHarqCurrentProcessId
virtual FfMacSchedSapProvider * GetFfMacSchedSapProvider()
uint32_t maxTokenPoolSize
current size of token pool (byte)
std::map< uint16_t, uint8_t > m_p10CqiRxed
a unique identifier for an interface.
Definition: type-id.h:49
void DoCschedUeReleaseReq(const struct FfMacCschedSapProvider::CschedUeReleaseReqParameters &params)
void UpdateUlRlcBufferInfo(uint16_t rnti, uint16_t size)
void DoCschedUeConfigReq(const struct FfMacCschedSapProvider::CschedUeConfigReqParameters &params)
uint8_t UpdateHarqProcessId(uint16_t rnti)
Update and return a new process Id for the RNTI specified.
std::map< uint16_t, uint32_t > m_ceBsrRxed
void UpdateDlRlcBufferInfo(uint16_t rnti, uint8_t lcid, uint16_t size)
void TransmissionModeConfigurationUpdate(uint16_t rnti, uint8_t txMode)